[
][
C:
/
Program Files (x86)
/
AWS SDK for .NET
/
past-releases
/
Version-1
/]
Upload
Terminal
File Manager
Server Info
Current File :
C:/Program Files (x86)/AWS SDK for .NET/past-releases/Version-1/AWSSDK.xml
<?xml version="1.0"?> <doc> <assembly> <name>AWSSDK</name> </assembly> <members> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifier"> <summary> An access control policy action identifies a specific action in a service that can be performed on a resource. For example, sending a message to a queue. <para> ActionIdentifiers allow you to limit what your access control policy statement affects. For example, you could create a policy statement that enables a certain group of users to send messages to your queue, but not allow them to perform any other actions on your queue. </para> <para> The action is B in the statement "A has permission to do B to C where D applies." </para> <para>Free form access control policy actions may include a wildcard (*) to match multiple actions. </para> <para> Constants for known actions can be found in the Amazon.Auth.AccessControlPolicy.ActionIdentifiers namespace. </para> </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ActionIdentifier.#ctor(System.String)"> <summary> Constructs an Actionidentifer with the given action name. </summary> <param name="actionName">The name of the action</param> </member> <member name="P:Amazon.Auth.AccessControlPolicy.ActionIdentifier.ActionName"> <summary> Gets and sets the name of this action. For example, 'sqs:SendMessage' is the name corresponding to the SQS action that enables users to send a message to an SQS queue. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.AutoScalingActionIdentifiers"> <summary> The available AWS access control policy actions for Auto Scaling. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudFormationActionIdentifiers"> <summary> The available AWS access control policy actions for AWS CloudFormation. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudFrontActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon CloudFront. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.CloudWatchActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon CloudWatch. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.DirectConnectActionIdentifiers"> <summary> The available AWS access control policy actions for AWS Direct Connect. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.DynamoDBActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon DynamoDB. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.EC2ActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon EC2. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElastiCacheActionIdentifiers"> <summary> The available AWS access control policy actions for AWS ElastiCache. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElasticBeanstalkActionIdentifiers"> <summary> The available AWS access control policy actions for AWS Elastic Beanstalk. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElasticLoadBalancingActionIdentifiers"> <summary> The available AWS access control policy actions for Elastic Load Balancing. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.ElasticMapReduceActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon Elastic MapReduce. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.GlacierActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon Glacier. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.IdentityandAccessManagementActionIdentifiers"> <summary> The available AWS access control policy actions for AWS Identity and Access Management. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.MarketplaceActionIdentifiers"> <summary> The available AWS access control policy actions for AWS Marketplace. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.RDSActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon RDS. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.RedshiftActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon Redshift. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.Route53ActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon Route 53. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SecurityTokenServiceActionIdentifiers"> <summary> The available AWS access control policy actions for AWS Security Token Service. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SESActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon SES. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SimpleDBActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon SimpleDB. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.WebsiteActionIdentifiers"> <summary> The available AWS access control policy actions for AWS Website. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyReader"> <summary> Deserializes a JSON string into a AWS policy object. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter"> <summary> Serializes an AWS policy object to a JSON string, suitable for sending to an AWS service. </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter.WritePolicyToString(System.Boolean,Amazon.Auth.AccessControlPolicy.Policy)"> Converts the specified AWS policy object to a JSON string, suitable for passing to an AWS service. @param policy The AWS policy object to convert to a JSON string. @return The JSON string representation of the specified policy object. @throws IllegalArgumentException If the specified policy is null or invalid and cannot be serialized to a JSON string. </member> <member name="M:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter.writePrincipals(Amazon.Auth.AccessControlPolicy.Statement,ThirdParty.Json.LitJson.JsonWriter)"> <summary> Uses the specified generator to write the JSON data for the principals in the specified policy statement. </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Internal.JsonPolicyWriter.sortConditionsByTypeAndKey(System.Collections.Generic.IList{Amazon.Auth.AccessControlPolicy.Condition})"> <summary> This sorts the conditions by condition type and key with the list of values for that combination. </summary> <param name="conditions">The list of conditions to be sorted.</param> <returns></returns> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.S3ActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon S3. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SNSActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon SNS. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ActionIdentifiers.SQSActionIdentifiers"> <summary> The available AWS access control policy actions for Amazon SQS. </summary> <see cref="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"/> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Condition"> <summary> AWS access control policy conditions are contained in <see cref="T:Amazon.Auth.AccessControlPolicy.Statement"/> objects, and affect when a statement is applied. For example, a statement that allows access to an Amazon SQS queue could use a condition to only apply the effect of that statement for requests that are made before a certain date, or that originate from a range of IP addresses. <para> Multiple conditions can be included in a single statement, and all conditions must evaluate to true in order for the statement to take effect. </para> <para> The set of conditions is D in the statement "A has permission to do B to C where D applies." </para> <para> A condition is composed of three parts: <list type="definition"> <item> <term>Condition Key</term> <description>The condition key declares which value of a request to pull in and compare against when a policy is evaluated by AWS. For example, using <see cref="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SOURCE_IP_CONDITION_KEY"/> will cause AWS to pull in the current request's source IP as the first value to compare against every time your policy is evaluated. </description> </item> <item> <term>Comparison Type</term> <description>This is a static value used as the second value in the comparison when your policy is evaluated. Depending on the comparison type, this value can optionally use wildcards. See the documentation for individual comparison types for more information. </description> </item> <item> <term>Comparison Value</term> <description>This is a static value used as the second value in the comparison when your policy is evaluated. Depending on the comparison type, this value can optionally use wildcards. See the documentation for individual comparison types for more information. </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Condition.Type"> <summary> Gets the type of this condition. </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Condition.ConditionKey"> <summary> Gets and Sets the name of the condition key involved in this condition. Condition keys are predefined values supported by AWS that provide input to a condition's evaluation, such as the current time, or the IP address of the incoming request. <para> Your policy is evaluated for each incoming request, and condition keys specify what information to pull out of those incoming requests and plug into the conditions in your policy. </para> </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Condition.Values"> <summary> Gets and Sets the values specified for this access control policy condition. For example, in a condition that compares the incoming IP address of a request to a specified range of IP addresses, the range of IP addresses is the single value in the condition. <para> Most conditions accept only one value, but multiple values are possible. </para> </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory"> <summary> A factory for creating conditions to be used in the policy. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.CURRENT_TIME_CONDITION_KEY"> <summary> Condition key for the current time. <para> This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.DateComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SECURE_TRANSPORT_CONDITION_KEY"> <summary> Condition key for whether or not an incoming request is using a secure transport to make the request (i.e. HTTPS instead of HTTP). <para> This condition key should only be used with the boolean overload of NewCondition. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SOURCE_IP_CONDITION_KEY"> <summary> Condition key for the source IP from which a request originates. <para> This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.USER_AGENT_CONDITION_KEY"> <summary> Condition key for the user agent included in a request. <para> This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.EPOCH_TIME_CONDITION_KEY"> <summary> Condition key for the current time, in epoch seconds. <para> This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.NumericComparisonType"/> enum. objects. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.REFERRER_CONDITION_KEY"> <summary> Condition key for the referrer specified by a request. <para> This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> objects. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SOURCE_ARN_CONDITION_KEY"> <summary> Condition key for the Amazon Resource Name (ARN) of the source specified in a request. The source ARN indicates which resource is affecting the resource listed in your policy. For example, an SNS topic is the source ARN when publishing messages from the topic to an SQS queue. <para> This condition key should only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_CANNED_ACL_CONDITION_KEY"> <summary> Condition key for the canned ACL specified by a request. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_LOCATION_CONSTRAINT_CONDITION_KEY"> <summary> Condition key for the location constraint specified by a request. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_PREFIX_CONDITION_KEY"> <summary> Condition key for the prefix specified by a request. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_DELIMITER_CONDITION_KEY"> <summary> Condition key for the delimiter specified by a request. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_MAX_KEYS_CONDITION_KEY"> <summary> Condition key for the max keys specified by a request. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_COPY_SOURCE_CONDITION_KEY"> <summary> Condition key for the source object specified by a request to copy an object. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_METADATA_DIRECTIVE_CONDITION_KEY"> <summary> Condition key for the metadata directive specified by a request to copy an object. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.S3_VERSION_ID_CONDITION_KEY"> <summary> Condition key for the version ID of an object version specified by a request. <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SNS_ENDPOINT_CONDITION_KEY"> <summary> Condition key for The URL, e-mail address, or ARN from a Subscribe request or a previously confirmed subscription. Use with string conditions to restrict access to specific endpoints (e.g., *@mycompany.com). <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.SNS_PROTOCOL_CONDITION_KEY"> <summary> Condition key for the protocol value from a Subscribe request or a previously confirmed subscription. Use with string conditions to restrict publication to specific delivery protocols (e.g., HTTPS). <para> This condition key may only be used with <see cref="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"/> enum. </para> </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType,System.String,System.String)"> <summary> Constructs a new access control policy condition that compares ARNs (Amazon Resource Names). </summary> <param name="key"> The access policy condition key specifying where to get the first ARN for the comparison</param> <param name="type">The type of comparison to perform.</param> <param name="value">The second ARN to compare against. When using ArnLike or ArnNotLike this may contain the multi-character wildcard (*) or the single-character wildcard</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(System.String,System.Boolean)"> <summary> Constructs a new access policy condition that performs a boolean comparison. </summary> <param name="key">The access policy condition key specifying where to get the first boolean value for the comparison (ex: aws:SecureTransport).</param> <param name="value">The boolean to compare against.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.DateComparisonType,System.DateTime)"> <summary> Constructs a new access policy condition that compares the current time (on the AWS servers) to the specified date. </summary> <param name="type">The type of comparison to perform. For example, DateComparisonType.DateLessThan will cause this policy condition to evaluate to true if the current date is less than the date specified in the second argument.</param> <param name="date">The date to compare against.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewIpAddressCondition(System.String)"> <summary> Constructs a new access policy condition that compares the source IP address of the incoming request to an AWS service against the specified CIDR range. The condition evaluates to true (meaning the policy statement containing it will be applied) if the incoming source IP address is within that range. <para> To achieve the opposite effect (i.e. cause the condition to evaluate to true when the incoming source IP is <b>not</b> in the specified CIDR range) use the alternate constructor form and specify IpAddressComparisonType.NotIpAddress. </para> </summary> <param name="ipAddressRange">The CIDR IP range involved in the policy condition.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType,System.String)"> <summary> Constructs a new access policy condition that compares the source IP address of the incoming request to an AWS service against the specified CIDR range. When the condition evaluates to true (i.e. when the incoming source IP address is within the CIDR range or not) depends on the specified IpAddressComparisonType. </summary> <param name="type">The type of comparison to to perform.</param> <param name="ipAddressRange">The CIDR IP range involved in the policy condition.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.NumericComparisonType,System.String,System.String)"> <summary> Constructs a new access policy condition that compares two numbers. </summary> <param name="type">The type of comparison to perform.</param> <param name="key">The access policy condition key specifying where to get the first number for the comparison.</param> <param name="value">The second number to compare against.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCondition(Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType,System.String,System.String)"> <summary> Constructs a new access control policy condition that compares two strings. </summary> <param name="type">The type of comparison to perform</param> <param name="key">The access policy condition key specifying where to get the first string for the comparison (ex: aws:UserAgent). </param> <param name="value">The second string to compare against. When using StringComparisonType.StringLike or StringComparisonType.StringNotLike this may contain the multi-character wildcard (*) or the single-character wildcard (?). </param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewSourceArnCondition(System.String)"> <summary> Constructs a new access policy condition that compares the Amazon Resource Name (ARN) of the source of an AWS resource that is modifying another AWS resource with the specified pattern. <para> For example, the source ARN could be an Amazon SNS topic ARN that is sending messages to an Amazon SQS queue. In that case, the SNS topic ARN would be compared the ARN pattern specified here. </para> <para> The endpoint pattern may optionally contain the multi-character wildcard * (*) or the single-character wildcard (?). Each of the six colon-delimited components of the ARN is checked separately and each can include a wildcard. </para> <code> Policy policy = new Policy("MyQueuePolicy"); policy.WithStatements(new Statement(Statement.StatementEffect.Allow) .WithPrincipals(new Principal("*")).WithActionIdentifiers(SQSActionIdentifiers.SendMessage) .WithResources(new Resource(myQueueArn)) .WithConditions(ConditionFactory.NewSourceArnCondition(myTopicArn))); </code> </summary> <param name="arnPattern">The ARN pattern against which the source ARN will be compared. Each of the six colon-delimited components of the ARN is checked separately and each can include a wildcard.</param> <returns>A new access control policy condition that compares the ARN of the source specified in an incoming request with the ARN pattern specified here.</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewSecureTransportCondition"> <summary> Constructs a new access control policy condition that tests if the incoming request was sent over a secure transport (HTTPS). </summary> <returns>A new access control policy condition that tests if the incoming request was sent over a secure transport (HTTPS).</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewCannedACLCondition(Amazon.S3.Model.S3CannedACL)"> <summary> Constructs a new access policy condition that compares an Amazon S3 canned ACL with the canned ACL specified by an incoming request. <para> You can use this condition to ensure that any objects uploaded to an Amazon S3 bucket have a specific canned ACL set. </para> </summary> <param name="cannedAcl">The Amazon S3 canned ACL to compare against.</param> <returns>A new access control policy condition that compares the Amazon S3 canned ACL specified in incoming requests against the value specified.</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewEndpointCondition(System.String)"> <summary> Constructs a new access policy condition that compares the requested endpoint used to subscribe to an Amazon SNS topic with the specified endpoint pattern. The endpoint pattern may optionally contain the multi-character wildcard (*) or the single-character wildcard (?). <para> For example, this condition can restrict subscriptions to a topic to email addresses in a certain domain ("*@my-company.com"). </para> <code> Policy policy = new Policy("MyTopicPolicy"); policy.WithStatements(new Statement(Statement.StatementEffect.Allow) .WithPrincipals(new Principal("*")).WithActionIdentifiers(SNSActionIdentifiers.Subscribe) .WithResources(new Resource(myTopicArn)) .WithConditions(ConditionFactory.NewEndpointCondition("*@my-company.com"))); </code> </summary> <param name="endpointPattern">The endpoint pattern against which to compare the requested endpoint for an Amazon SNS topic subscription.</param> <returns>A new access control policy condition that compares the endpoint used in a request to subscribe to an Amazon SNS topic with the endpoint pattern specified.</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ConditionFactory.NewProtocolCondition(System.String)"> <summary> Constructs a new AWS access control policy condition that allows an access control statement to restrict subscriptions to an Amazon SNS topic based on the protocol being used for the subscription. For example, this condition can restrict subscriptions to a topic to endpoints using HTTPS to ensure that messages are securely delivered. </summary> <param name="protocol">The protocol against which to compare the requested protocol for an Amazon SNS topic subscription.</param> <returns>A new access control policy condition that compares the notification protocol requested in a request to subscribe to an Amazon SNS topic with the protocol value specified.</returns> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType"> <summary> Enumeration of the supported ways an ARN comparison can be evaluated. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnEquals"> <summary>Exact matching</summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnLike"> <summary> Loose case-insensitive matching of the ARN. Each of the six colon-delimited components of the ARN is checked separately and each can include a multi-character match wildcard (*) or a single-character match wildcard (?). </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnNotEquals"> <summary>Negated form of ArnEquals</summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.ArnComparisonType.ArnNotLike"> <summary>Negated form of ArnLike</summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.DateComparisonType"> <summary> Enumeration of the supported ways a date comparison can be evaluated. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType"> <summary> Enumeration of the supported ways an IP address comparison can be evaluated. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType.IpAddress"> <summary> Matches an IP address against a CIDR IP range, evaluating to true if the IP address being tested is in the condition's specified CIDR IP range. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.IpAddressComparisonType.NotIpAddress"> <summary> Negated form of IpAddress </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.NumericComparisonType"> <summary> Enumeration of the supported ways a numeric comparison can be evaluated </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType"> <summary> Enumeration of the supported ways a string comparison can be evaluated. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringEquals"> <summary> Case-sensitive exact string matching </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringEqualsIgnoreCase"> <summary> Case-insensitive string matching </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringLike"> <summary> Loose case-insensitive matching. The values can include a multi-character match wildcard (*) or a single-character match wildcard (?) anywhere in the string. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringNotEquals"> <summary> Negated form of StringEquals. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringNotEqualsIgnoreCase"> <summary> Negated form of StringEqualsIgnorecase. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.ConditionFactory.StringComparisonType.StringNotLike"> <summary> Negated form of StringLike. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Policy"> <summary> An AWS access control policy is a object that acts as a container for one or more statements, which specify fine grained rules for allowing or denying various types of actions from being performed on your AWS resources. <para> By default, all requests to use your resource coming from anyone but you are denied. Access control polices can override that by allowing different types of access to your resources, or by explicitly denying different types of access. </para> <para> Each statement in an AWS access control policy takes the form: "A has permission to do B to C where D applies". <list type="definition"> <item> <term>A is the prinicpal</term> <description>The AWS account that is making a request to access or modify one of your AWS resources. </description> </item> <item> <term>B is the action</term> <description>the way in which your AWS resource is being accessed or modified, such as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. </description> </item> <item> <term>C is the resource</term> <description>your AWS entity that the principal wants to access, such as an Amazon SQS queue, or an object stored in Amazon S3. </description> </item> <item> <term>D is the set of conditions</term> <description>optional constraints that specify when to allow or deny access for the principal to access your resource. Many expressive conditions are available, some specific to each service. For example you can use date conditions to allow access to your resources only after or before a specific time. </description> </item> </list> </para> <para> Note that an AWS access control policy should not be confused with the similarly named "POST form policy" concept used in Amazon S3. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.Policy.DEFAULT_POLICY_VERSION"> <summary> The default policy version </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.#ctor"> <summary> Constructs an empty AWS access control policy ready to be populated with statements. </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.#ctor(System.String)"> <summary> Constructs a new AWS access control policy with the specified policy ID. The policy ID is a user specified string that serves to help developers keep track of multiple polices. Policy IDs are often used as a human readable name for a policy. </summary> <param name="id">The policy ID for the new policy object. Policy IDs serve to help developers keep track of multiple policies, and are often used to give the policy a meaningful, human readable name.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.#ctor(System.String,System.Collections.Generic.IList{Amazon.Auth.AccessControlPolicy.Statement})"> <summary> Constructs a new AWS access control policy with the specified policy ID and collection of statements. The policy ID is a user specified string that serves to help developers keep track of multiple polices. Policy IDs are often used as a human readable name for a policy. </summary> <param name="id">The policy ID for the new policy object. Policy IDs serve to help developers keep track of multiple policies, and are often used to give the policy a meaningful, human readable name.</param> <param name="statements">The statements to include in the new policy.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.WithId(System.String)"> <summary> Sets the policy ID for this policy and returns the updated policy so that multiple calls can be chained together. <para> Policy IDs serve to help developers keep track of multiple policies, and are often used as human readable name for a policy. </para> </summary> <paraparam name="id">The polich ID for this policy</paraparam> <returns>this instance</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.WithStatements(Amazon.Auth.AccessControlPolicy.Statement[])"> <summary> Sets the collection of statements contained by this policy and returns this policy object so that additional method calls can be chained together. <para> Individual statements in a policy are what specify the rules that enable or disable access to your AWS resources. </para> </summary> <param name="statements">The collection of statements included in this policy.</param> <returns>this instance</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.ToJson"> <summary> Returns a JSON string representation of this AWS access control policy, suitable to be sent to an AWS service as part of a request to set an access control policy. </summary> <returns>A JSON string representation of this AWS access control policy.</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.ToJson(System.Boolean)"> <summary> Returns a JSON string representation of this AWS access control policy, suitable to be sent to an AWS service as part of a request to set an access control policy. </summary> <param name="prettyPrint">Toggle pretty print for the generated JSON document</param> <returns>A JSON string representation of this AWS access control policy.</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.FromJson(System.String)"> <summary> Parses a JSON document of a policy and creates a Policy object. </summary> <param name="json">JSON document of a policy.</param> <returns></returns> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Policy.Id"> <summary> Gets and Sets the policy ID for this policy. Policy IDs serve to help developers keep track of multiple policies, and are often used as human readable name for a policy. </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Policy.Version"> <summary> Gets the version of this AWS policy. </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Policy.Statements"> <summary> Gets and Sets the collection of statements contained by this policy. Individual statements in a policy are what specify the rules that enable or disable access to your AWS resources. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Principal"> <summary> A principal is an AWS account which is being allowed or denied access to a resource through an access control policy. The principal is a property of the Statement object, not directly the <see cref="T:Amazon.Auth.AccessControlPolicy.Policy"/> object. <para> The principal is A in the statement "A has permission to do B to C where D applies." </para> <para> In an access control policy statement, you can set the principal to all authenticated AWS users through the <see cref="F:Amazon.Auth.AccessControlPolicy.Principal.AllUsers"/> member. This is useful when you don't want to restrict access based on the identity of the requester, but instead on other identifying characteristics such as the requester's IP address. </para> </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.Principal.AWS_PROVIDER"> <summary> The default Principal provider for AWS accounts. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.Principal.CANONICAL_USER_PROVIDER"> <summary> Principal provider for Canonical User IDs. </summary> </member> <member name="F:Amazon.Auth.AccessControlPolicy.Principal.AllUsers"> <summary> Principal instance that includes all users, including anonymous users. <para> This is useful when you don't want to restrict access based on the identity of the requester, but instead on other identifying characteristics such as the requester's IP address. </para> </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Principal.#ctor(System.String)"> <summary> Constructs a new principal with the specified AWS account ID. </summary> <param name="accountId">An AWS account ID.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Principal.#ctor(System.String,System.String)"> <summary> Constructs a new principal with the specified provider and id </summary> <param name="provider">The provider of the principal</param> <param name="id">The unique ID of the Principal within the provider</param> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Principal.Provider"> <summary> Gets and sets the provider for this principal, which indicates in what group of users this principal resides. </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Principal.Id"> <summary> Gets the unique ID for this principal. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Resource"> <summary> Represents a resource involved in an AWS access control policy statement. Resources are the service specific AWS entities owned by your account. Amazon SQS queues, Amazon S3 buckets and objects, and Amazon SNS topics are all examples of AWS resources. <para> The standard way of specifying an AWS resource is with an Amazon Resource Name (ARN). </para> <para> The resource is C in the statement "A has permission to do B to C where D applies." </para> </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Resource.#ctor(System.String)"> <summary> Constructs a new AWS access control policy resource. Resources are typically specified as Amazon Resource Names (ARNs). <para> You specify the resource using the following Amazon Resource Name (ARN) format: arn:aws:<vendor>:<region>:<namespace>:<relative-id> <list type="bullet"> <item> <description>>vendor identifies the AWS product (e.g., sns)</description> </item> <item> <description>region is the AWS Region the resource resides in (e.g., us-east-1), if any</description> </item> <item> <description>namespace is the AWS account ID with no hyphens (e.g., 123456789012)</description> </item> <item> <description>relative-id is the service specific portion that identifies the specific resource</description> </item> </list> </para> <para> For example, an Amazon SQS queue might be addressed with the following ARN: arn:aws:sqs:us-east-1:987654321000:MyQueue </para> <para> Some resources may not use every field in an ARN. For example, resources in Amazon S3 are global, so they omit the region field: arn:aws:s3:::bucket/* </para> </summary> <param name="resource">The Amazon Resource Name (ARN) uniquely identifying the desired AWS resource.</param> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Resource.Id"> <summary> Gets the resource ID, typically an Amazon Resource Name (ARN), identifying this resource. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.ResourceFactory"> <summary> A factory for creating resources to be used in the policy. </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ResourceFactory.NewS3BucketResource(System.String)"> <summary> Constructs a new bucket resource that represents the the specified bucket but <b>not any of the contained objects</b>. </summary> <param name="bucketName">The name of the bucket represented by this AWS access control policy resource.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ResourceFactory.NewS3ObjectResource(System.String,System.String)"> <summary> Constructs a new object resource that represents the specified objects. The keyPattern argument may contain the '*' wildcard to match multiple objects. For example, an object resource created for bucket 'mybucket' and key pattern 'foo*' will match any object stored in 'mybucket' with a key that starts with 'foo'. </summary> <param name="bucketName">The name of the bucket containing the object or objects represented by this resource.</param> <param name="keyPattern">The key or key pattern, which can optionally contain the '*' wildcard to include multiple objects in the resource.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.ResourceFactory.NewSQSQueueResource(System.String,System.String)"> <summary> Constructs a new SQS queue resource for an access control policy. A policy statement using this resource will allow or deny actions on the specified queue. </summary> <param name="accountId">The AWS account ID of the queue owner.</param> <param name="queueName">The name of the Amazon SQS queue.</param> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Statement"> <summary> A statement is the formal description of a single permission, and is always contained within a policy object. <para> A statement describes a rule for allowing or denying access to a specific AWS resource based on how the resource is being accessed, and who is attempting to access the resource. Statements can also optionally contain a list of conditions that specify when a statement is to be honored. </para> <para> For example, consider a statement that: <list type="definition"> <item> <term>A is the prinicpal</term> <description>The AWS account that is making a request to access or modify one of your AWS resources. </description> </item> <item> <term>B is the action</term> <description>the way in which your AWS resource is being accessed or modified, such as sending a message to an Amazon SQS queue, or storing an object in an Amazon S3 bucket. </description> </item> <item> <term>C is the resource</term> <description>your AWS entity that the principal wants to access, such as an Amazon SQS queue, or an object stored in Amazon S3. </description> </item> <item> <term>D is the set of conditions</term> <description>optional constraints that specify when to allow or deny access for the principal to access your resource. Many expressive conditions are available, some specific to each service. For example you can use date conditions to allow access to your resources only after or before a specific time. </description> </item> </list> </para> <para> There are many resources and conditions available for use in statements, and you can combine them to form fine grained custom access control polices. </para> </summary> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Statement.#ctor(Amazon.Auth.AccessControlPolicy.Statement.StatementEffect)"> <summary> Constructs a new access control policy statement with the specified effect. <para> Before a statement is valid and can be sent to AWS, callers must set the principals, resources, and actions (as well as any optional conditions) involved in the statement. </para> </summary> <param name="effect">The effect this statement has (allowing access or denying access) when all conditions, resources, principals, and actions are matched.</param> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithId(System.String)"> <summary> Sets the ID for this statement and returns the updated statement so multiple calls can be chained together. <para> Statement IDs serve to help keep track of multiple statements, and are often used to give the statement a meaningful, human readable name. </para> <para> Developers should be careful to not use the same statement ID for multiple statements in the same policy. Reusing the same statement ID in different policies is not a problem. </para> </summary> <param name="id">The new statement ID for this statement.</param> <returns>this instance</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithActionIdentifiers(Amazon.Auth.AccessControlPolicy.ActionIdentifier[])"> <summary> Sets the list of actions to which this policy statement applies and returns this updated Statement object so that additional method calls can be chained together. <para> Actions limit a policy statement to specific service operations that are being allowed or denied by the policy statement. For example, you might want to allow any AWS user to post messages to your SQS queue using the SendMessage action, but you don't want to allow those users other actions such as ReceiveMessage or DeleteQueue. </para> </summary> <param name="actions">The list of actions to which this statement applies.</param> <returns>this instance</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithResources(Amazon.Auth.AccessControlPolicy.Resource[])"> <summary> Sets the resources associated with this policy statement and returns this updated Statement object so that additional method calls can be chained together. <para> Resources are what a policy statement is allowing or denying access to, such as an Amazon SQS queue or an Amazon SNS topic. </para> <para> Note that some services allow only one resource to be specified per policy statement. </para> </summary> <param name="resources">The resources associated with this policy statement.</param> <returns>this instance</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithConditions(Amazon.Auth.AccessControlPolicy.Condition[])"> <summary> Sets the conditions associated with this policy statement, and returns this updated Statement object so that additional method calls can be chained together. <para> Conditions allow policy statements to be conditionally evaluated based on the many available condition types. </para> <para> For example, a statement that allows access to an Amazon SQS queue could use a condition to only apply the effect of that statement for requests that are made before a certain date, or that originate from a range of IP addresses. </para> <para> Multiple conditions can be included in a single statement, and all conditions must evaluate to true in order for the statement to take effect. </para> </summary> <param name="conditions">The conditions associated with this policy statement.</param> <returns>this instance</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Statement.WithPrincipals(Amazon.Auth.AccessControlPolicy.Principal[])"> <summary> Sets the principals associated with this policy statement, and returns this updated Statement object. Principals control which AWS accounts are affected by this policy statement. <para> If you don't want to restrict your policy to specific users, you can use <see cref="F:Amazon.Auth.AccessControlPolicy.Principal.AllUsers"/> to apply the policy to any user trying to access your resource. </para> </summary> <param name="principals">The list of principals associated with this policy statement.</param> <returns>this instance</returns> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Statement.Id"> <summary> Gets and Sets the ID for this statement. Statement IDs serve to help keep track of multiple statements, and are often used to give the statement a meaningful, human readable name. <para> Developers should be careful to not use the same statement ID for multiple statements in the same policy. Reusing the same statement ID in different policies is not a problem. </para> </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Statement.Effect"> <summary> Gets and Sets the result effect of this policy statement when it is evaluated. A policy statement can either allow access or explicitly </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Statement.Actions"> <summary> Gets and Sets the list of actions to which this policy statement applies. Actions limit a policy statement to specific service operations that are being allowed or denied by the policy statement. For example, you might want to allow any AWS user to post messages to your SQS queue using the SendMessage action, but you don't want to allow those users other actions such as ReceiveMessage or DeleteQueue. </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Statement.Resources"> <summary> Gets and Sets the resources associated with this policy statement. Resources are what a policy statement is allowing or denying access to, such as an Amazon SQS queue or an Amazon SNS topic. <para> Note that some services allow only one resource to be specified per policy statement. </para> </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Statement.Conditions"> <summary> Gets and Sets the conditions associated with this policy statement. Conditions allow policy statements to be conditionally evaluated based on the many available condition types. <para> For example, a statement that allows access to an Amazon SQS queue could use a condition to only apply the effect of that statement for requests that are made before a certain date, or that originate from a range of IP addresses. </para> <para> When multiple conditions are included in a single statement, all conditions must evaluate to true in order for the statement to take effect. </para> </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Statement.Principals"> <summary> Gets and Sets the principals associated with this policy statement, indicating which AWS accounts are affected by this policy statement. </summary> </member> <member name="T:Amazon.Auth.AccessControlPolicy.Statement.StatementEffect"> <summary> The effect is the result that you want a policy statement to return at evaluation time. A policy statement can either allow access or explicitly deny access. </summary> </member> <member name="T:Amazon.AutoScaling.AmazonAutoScaling"> <summary> Implementation for accessing AutoScaling Auto Scaling <para> Auto Scaling is a web service designed to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on user-defined policies, schedules, and health checks. This service is used in conjunction with Amazon CloudWatch and Elastic Load Balancing services. </para> <para> Auto Scaling provides APIs that you can call by submitting a Query Request. Query requests are HTTP or HTTPS requests that use the HTTP verbs GET or POST and a Query parameter named <i>Action</i> or <i>Operation</i> that specifies the API you are calling. Action is used throughout this documentation, although Operation is also supported for backward compatibility with other Amazon Web Services (AWS) Query APIs. </para> <para> Calling the API using a Query request is the most direct way to access the web service, but requires that your application handle low-level details such as generating the hash to sign the request and error handling. The benefit of calling the service using a Query request is that you are assured of having access to the complete functionality of the API. For information about signing a a query request, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/api_requests.html">Use Query Requests to Call Auto Scaling APIs</a> </para> <para> This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors. For detailed information about Auto Scaling features and their associated API actions, go to the <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/">Auto Scaling Developer Guide</a>. </para> <para> This reference is based on the current WSDL, which is available at: </para> <para> <a href="http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl">http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl</a> </para> <para> <b>Endpoints</b> </para> <para> The examples in this guide assume that your instances are launched in the US East (Northern Virginia) region and use us-east-1 as the endpoint. </para> <para> You can set up your Auto Scaling infrastructure in other AWS regions. For information about this product's regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html">Regions and Endpoints</a> in the Amazon Web Services General Reference. </para> </summary> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.AttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest)"> <summary> Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach Amazon EC2 Instance(s) to Your Existing 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginAttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachInstances operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndAttachInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachInstances.</param> <returns>Returns a AttachInstancesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.CompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginCompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CompleteLifecycleAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteLifecycleAction operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndCompleteLifecycleAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CompleteLifecycleAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCompleteLifecycleAction.</param> <returns>Returns a CompleteLifecycleActionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.CreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest)"> <summary> Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls. <note> The Auto Scaling group name must be unique within the scope of your AWS account. </note> </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginCreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndCreateAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAutoScalingGroup.</param> <returns>Returns a CreateAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.CreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest)"> <summary> Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use. </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginCreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLaunchConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndCreateLaunchConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLaunchConfiguration.</param> <returns>Returns a CreateLaunchConfigurationResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.CreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest)"> <summary> Creates new tags or updates existing tags for an Auto Scaling group. <note> A tag's definition is composed of a resource ID, resource type, key and value, and the propagate flag. Value and the propagate flag are optional parameters. See the Request Parameters for more information. </note> <para> For information on creating tags for your Auto Scaling group, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tag Your Auto Scaling Groups and Amazon EC2 Instances</a>. </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginCreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateOrUpdateTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateOrUpdateTags operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndCreateOrUpdateTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateOrUpdateTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateOrUpdateTags.</param> <returns>Returns a CreateOrUpdateTagsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest)"> <summary> Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress. <note> To remove all instances before calling <a>DeleteAutoScalingGroup</a>, you can call <a>UpdateAutoScalingGroup</a> to set the minimum and maximum size of the AutoScalingGroup to zero. </note> </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.ResourceInUseException"> This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used. </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDeleteAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAutoScalingGroup.</param> <returns>Returns a DeleteAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest)"> <summary> Deletes the specified <a>LaunchConfiguration</a>. <para> The specified 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.ResourceInUseException"> This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLaunchConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDeleteLaunchConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLaunchConfiguration.</param> <returns>Returns a DeleteLaunchConfigurationResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleHook operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDeleteLifecycleHook(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLifecycleHook.</param> <returns>Returns a DeleteLifecycleHookResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest)"> <summary> Deletes notifications created by <a>PutNotificationConfiguration</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNotificationConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDeleteNotificationConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNotificationConfiguration.</param> <returns>Returns a DeleteNotificationConfigurationResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest)"> <summary> Deletes a policy created by <a>PutScalingPolicy</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePolicy operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDeletePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePolicy.</param> <returns>Returns a DeletePolicyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest)"> <summary> Deletes a scheduled action previously created using the <a>PutScheduledUpdateGroupAction</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteScheduledAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteScheduledAction operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDeleteScheduledAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteScheduledAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteScheduledAction.</param> <returns>Returns a DeleteScheduledActionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest)"> <summary> Removes the specified tags or a set of tags from a set of resources. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTags operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDeleteTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTags.</param> <returns>Returns a DeleteTagsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAccountLimits"> <summary> Returns the limits for the Auto Scaling resources currently allowed for your AWS account. <para> Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of <code>20</code> Auto Scaling groups and <code>100</code> launch configurations per region. </para> <para> If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the <a href="https://aws.amazon.com/support/">Support Center</a> and place a request to raise the limits. </para> </summary> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest)"> <summary> Returns the limits for the Auto Scaling resources currently allowed for your AWS account. <para> Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of <code>20</code> Auto Scaling groups and <code>100</code> launch configurations per region. </para> <para> If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the <a href="https://aws.amazon.com/support/">Support Center</a> and place a request to raise the limits. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAccountLimits operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeAccountLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAccountLimits operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAccountLimits.</param> <returns>Returns a DescribeAccountLimitsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAdjustmentTypes"> <summary> Returns policy adjustment types for use in the <a>PutScalingPolicy</a> action. </summary> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest)"> <summary> Returns policy adjustment types for use in the <a>PutScalingPolicy</a> action. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAdjustmentTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAdjustmentTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeAdjustmentTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAdjustmentTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAdjustmentTypes.</param> <returns>Returns a DescribeAdjustmentTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAutoScalingGroups"> <summary> Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest)"> <summary> Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingGroups operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAutoScalingGroups operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeAutoScalingGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingGroups operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAutoScalingGroups.</param> <returns>Returns a DescribeAutoScalingGroupsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAutoScalingInstances"> <summary> Returns a description of each Auto Scaling instance in the <code>InstanceIds</code> list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest)"> <summary> Returns a description of each Auto Scaling instance in the <code>InstanceIds</code> list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAutoScalingInstances operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeAutoScalingInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAutoScalingInstances.</param> <returns>Returns a DescribeAutoScalingInstancesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAutoScalingNotificationTypes"> <summary> Returns a list of all notification types that are supported by Auto Scaling. </summary> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest)"> <summary> Returns a list of all 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAutoScalingNotificationTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeAutoScalingNotificationTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAutoScalingNotificationTypes.</param> <returns>Returns a DescribeAutoScalingNotificationTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeLaunchConfigurations"> <summary> Returns a full description of the launch configurations, or the specified launch configurations, if they exist. <para> If no name is specified, then the full details of all launch configurations are returned. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest)"> <summary> Returns a full description of the launch configurations, or the specified launch configurations, if they exist. <para> If no name is specified, then the full details of all launch configurations are returned. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLaunchConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLaunchConfigurations operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeLaunchConfigurations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLaunchConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLaunchConfigurations.</param> <returns>Returns a DescribeLaunchConfigurationsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHooks operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLifecycleHooks operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeLifecycleHooks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLifecycleHooks operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLifecycleHooks.</param> <returns>Returns a DescribeLifecycleHooksResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLifecycleHookTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeLifecycleHookTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLifecycleHookTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLifecycleHookTypes.</param> <returns>Returns a DescribeLifecycleHookTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeMetricCollectionTypes"> <summary> Returns a list of metrics and a corresponding list of granularities for each metric. </summary> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest)"> <summary> Returns a list of metrics and a corresponding list of granularities for each metric. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMetricCollectionTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeMetricCollectionTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeMetricCollectionTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeMetricCollectionTypes.</param> <returns>Returns a DescribeMetricCollectionTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeNotificationConfigurations"> <summary> Returns a list of notification actions associated with Auto Scaling groups for specified events. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest)"> <summary> Returns a list of notification actions associated with Auto Scaling groups for specified events. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNotificationConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNotificationConfigurations operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeNotificationConfigurations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNotificationConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNotificationConfigurations.</param> <returns>Returns a DescribeNotificationConfigurationsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribePolicies"> <summary> Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest)"> <summary> Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePolicies operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePolicies operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribePolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePolicies operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePolicies.</param> <returns>Returns a DescribePoliciesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeScalingActivities"> <summary> Returns the scaling activities for the specified Auto Scaling group. <para> If the specified <code>ActivityIds</code> list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list. </para> <para> This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest)"> <summary> Returns the scaling activities for the specified Auto Scaling group. <para> If the specified <code>ActivityIds</code> list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list. </para> <para> This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingActivities operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScalingActivities operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeScalingActivities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingActivities operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingActivities.</param> <returns>Returns a DescribeScalingActivitiesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeScalingProcessTypes"> <summary> Returns scaling process types for use in the <a>ResumeProcesses</a> and <a>SuspendProcesses</a> actions. </summary> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest)"> <summary> Returns scaling process types for use in the <a>ResumeProcesses</a> and <a>SuspendProcesses</a> actions. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingProcessTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScalingProcessTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeScalingProcessTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingProcessTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingProcessTypes.</param> <returns>Returns a DescribeScalingProcessTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeScheduledActions"> <summary> Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in <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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest)"> <summary> Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in <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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScheduledActions operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScheduledActions operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeScheduledActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScheduledActions operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScheduledActions.</param> <returns>Returns a DescribeScheduledActionsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeTags"> <summary> Lists the Auto Scaling group tags. <para> You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your 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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest)"> <summary> Lists the Auto Scaling group tags. <para> You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your 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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTags operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTags.</param> <returns>Returns a DescribeTagsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeTerminationPolicyTypes"> <summary> Returns a list of all termination policies supported by Auto Scaling. </summary> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest)"> <summary> Returns a list of all 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTerminationPolicyTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDescribeTerminationPolicyTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTerminationPolicyTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTerminationPolicyTypes.</param> <returns>Returns a DescribeTerminationPolicyTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachInstances operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDetachInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachInstances.</param> <returns>Returns a DetachInstancesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.DisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest)"> <summary> Disables monitoring of group metrics for the Auto Scaling group specified in <code>AutoScalingGroupName</code>. You can specify the list of affected metrics with the <code>Metrics</code> parameter. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginDisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableMetricsCollection operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndDisableMetricsCollection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableMetricsCollection.</param> <returns>Returns a DisableMetricsCollectionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest)"> <summary> Enables monitoring of group metrics for the Auto Scaling group specified in <code>AutoScalingGroupName</code>. You can specify the list of enabled metrics with the <code>Metrics</code> parameter. <para> Auto Scaling metrics collection can be turned on only if the <code>InstanceMonitoring</code> flag, in the Auto Scaling group's launch configuration, 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginEnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableMetricsCollection operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndEnableMetricsCollection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableMetricsCollection.</param> <returns>Returns a EnableMetricsCollectionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginEnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnterStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnterStandby operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndEnterStandby(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnterStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnterStandby.</param> <returns>Returns a EnterStandbyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginExecutePolicy(Amazon.AutoScaling.Model.ExecutePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecutePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the ExecutePolicy operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecutePolicy operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndExecutePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExecutePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecutePolicy.</param> <returns>Returns a ExecutePolicyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.ExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExitStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExitStandby operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndExitStandby(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExitStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExitStandby.</param> <returns>Returns a ExitStandbyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.PutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginPutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleHook operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndPutLifecycleHook(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutLifecycleHook.</param> <returns>Returns a PutLifecycleHookResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.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">Get Email Notifications When Your Auto Scaling Group Changes</a> </para> <para> A new <code>PutNotificationConfiguration</code> 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"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginPutNotificationConfiguration(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutNotificationConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndPutNotificationConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutNotificationConfiguration.</param> <returns>Returns a PutNotificationConfigurationResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.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 parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. </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"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginPutScalingPolicy(Amazon.AutoScaling.Model.PutScalingPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScalingPolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutScalingPolicy operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndPutScalingPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutScalingPolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutScalingPolicy.</param> <returns>Returns a PutScalingPolicyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.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 information on creating or updating a scheduled action for your Auto Scaling group, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scale Based on a Schedule</a>. </para> <note> <para> Auto Scaling supports the date and time expressed in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only. </para> </note> </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginPutScheduledUpdateGroupAction(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutScheduledUpdateGroupAction operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndPutScheduledUpdateGroupAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutScheduledUpdateGroupAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutScheduledUpdateGroupAction.</param> <returns>Returns a PutScheduledUpdateGroupActionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.RecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginRecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRecordLifecycleActionHeartbeat operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndRecordLifecycleActionHeartbeat(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RecordLifecycleActionHeartbeat operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRecordLifecycleActionHeartbeat.</param> <returns>Returns a RecordLifecycleActionHeartbeatResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.ResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest)"> <summary> Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Process</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResumeProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResumeProcesses operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndResumeProcesses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResumeProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResumeProcesses.</param> <returns>Returns a ResumeProcessesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.SetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest)"> <summary> Sets the desired size of the specified <a>AutoScalingGroup</a>. </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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginSetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetDesiredCapacity operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetDesiredCapacity operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndSetDesiredCapacity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetDesiredCapacity operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetDesiredCapacity.</param> <returns>Returns a SetDesiredCapacityResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.SetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest)"> <summary> Sets the health status of a specified instance that belongs to any of your Auto Scaling groups. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-configure-healthcheck.html">Configure Health Checks for Your Auto Scaling group</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginSetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetInstanceHealth operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetInstanceHealth operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndSetInstanceHealth(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetInstanceHealth operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetInstanceHealth.</param> <returns>Returns a SetInstanceHealthResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.SuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest)"> <summary> Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the <code>ScalingProcesses.member.N</code> parameter. To suspend all process types, omit the <code>ScalingProcesses.member.N</code> parameter. <important> <para> Suspending either of the two primary process types, <code>Launch</code> or <code>Terminate</code>, can prevent other process types from functioning properly. </para> </important> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a> For more information on suspending and resuming Auto Scaling process, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Process</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginSuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SuspendProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSuspendProcesses operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndSuspendProcesses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SuspendProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSuspendProcesses.</param> <returns>Returns a SuspendProcessesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.TerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest)"> <summary> Terminates the specified instance. Optionally, the desired group size can be adjusted. <note> This call simply registers a termination request. The termination of the instance cannot happen immediately. </note> </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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginTerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateInstanceInAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndTerminateInstanceInAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateInstanceInAutoScalingGroup.</param> <returns>Returns a TerminateInstanceInAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.UpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest)"> <summary> Updates the configuration for the specified <a>AutoScalingGroup</a>. <note> <para> To update an Auto Scaling group with a launch configuration that has the <code>InstanceMonitoring</code> flag set to <code>False</code>, you must first ensure that collection of group metrics is disabled. Otherwise, calls to <a>UpdateAutoScalingGroup</a> will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling <a>DisableMetricsCollection</a>. </para> </note> <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> <note> <ul> <li> <para> If a new value is specified for <i>MinSize</i> without specifying the value for <i>DesiredCapacity</i>, and if the new <i>MinSize</i> is larger than the current size of the Auto Scaling Group, there will be an implicit call to <a>SetDesiredCapacity</a> to set the group to the new <i>MinSize</i>. </para> </li> <li> <para> If a new value is specified for <i>MaxSize</i> without specifying the value for <i>DesiredCapacity</i>, and the new <i>MaxSize</i> is smaller than the current size of the Auto Scaling Group, there will be an implicit call to <a>SetDesiredCapacity</a> to set the group to the new <i>MaxSize</i>. </para> </li> <li> <para> All other optional parameters are left unchanged if not passed in the request. </para> </li> </ul> </note> </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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.BeginUpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScaling.EndUpdateAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAutoScalingGroup.</param> <returns>Returns a UpdateAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="T:Amazon.AutoScaling.AmazonAutoScalingClient"> <summary> Implementation for accessing AutoScaling Auto Scaling <para> Auto Scaling is a web service designed to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on user-defined policies, schedules, and health checks. This service is used in conjunction with Amazon CloudWatch and Elastic Load Balancing services. </para> <para> Auto Scaling provides APIs that you can call by submitting a Query Request. Query requests are HTTP or HTTPS requests that use the HTTP verbs GET or POST and a Query parameter named <i>Action</i> or <i>Operation</i> that specifies the API you are calling. Action is used throughout this documentation, although Operation is also supported for backward compatibility with other Amazon Web Services (AWS) Query APIs. </para> <para> Calling the API using a Query request is the most direct way to access the web service, but requires that your application handle low-level details such as generating the hash to sign the request and error handling. The benefit of calling the service using a Query request is that you are assured of having access to the complete functionality of the API. For information about signing a a query request, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/api_requests.html">Use Query Requests to Call Auto Scaling APIs</a> </para> <para> This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors. For detailed information about Auto Scaling features and their associated API actions, go to the <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/">Auto Scaling Developer Guide</a>. </para> <para> This reference is based on the current WSDL, which is available at: </para> <para> <a href="http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl">http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl</a> </para> <para> <b>Endpoints</b> </para> <para> The examples in this guide assume that your instances are launched in the US East (Northern Virginia) region and use us-east-1 as the endpoint. </para> <para> You can set up your Auto Scaling infrastructure in other AWS regions. For information about this product's regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html">Regions and Endpoints</a> in the Amazon Web Services General Reference. </para> </summary> </member> <member name="T:Amazon.Runtime.AmazonWebServiceClient"> <summary> A base class for service clients that handles making the actual requests and possibly retries if needed. </summary> </member> <member name="M:Amazon.Runtime.AmazonWebServiceClient.Dispose(System.Boolean)"> <summary> Implements the Dispose pattern for the AmazonWebServiceClient </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.AmazonWebServiceClient.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="M:Amazon.Runtime.AmazonWebServiceClient.Finalize"> <summary> The destructor for the client class. </summary> </member> <member name="M:Amazon.Runtime.AmazonWebServiceClient.ConfigureWebRequest(Amazon.Runtime.Internal.AsyncResult)"> <summary> Creates the HttpWebRequest and configures the end point, content, user agent and proxy settings. </summary> <param name="asyncResult">The async request.</param> <returns>The web request that actually makes the call.</returns> </member> <member name="M:Amazon.Runtime.AmazonWebServiceClient.ShouldRetry(System.Net.HttpStatusCode,Amazon.Runtime.ClientConfig,Amazon.Runtime.AmazonServiceException,System.Int32)"> <summary> Returns true if a failed request should be retried. </summary> <param name="statusCode">The HTTP status code from the failed request</param> <param name="config">The client config</param> <param name="errorResponseException">The exception from the failed request</param> <param name="retries">The number of times the current request has been attempted</param> <returns>True if the failed request should be retried.</returns> </member> <member name="M:Amazon.Runtime.AmazonWebServiceClient.pauseExponentially(System.Int32)"> <summary> Exponential sleep on failed request to avoid flooding a service with retries. </summary> <param name="retries">Current retry count.</param> </member> <member name="E:Amazon.Runtime.AmazonWebServiceClient.BeforeRequestEvent"> <summary> Occurs before a request is issued against the service. </summary> </member> <member name="E:Amazon.Runtime.AmazonWebServiceClient.AfterResponseEvent"> <summary> Occurs after a response is received from the service. </summary> </member> <member name="E:Amazon.Runtime.AmazonWebServiceClient.ExceptionEvent"> <summary> Occurs after an exception is encountered. </summary> </member> <member name="P:Amazon.Runtime.AmazonWebServiceClient.ServiceURL"> <summary> Gets the service url endpoint used by this client. </summary> </member> <member name="P:Amazon.Runtime.AmazonWebServiceClient.Credentials"> <summary> Gets the AWSCredentials object used for signing requests. </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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 Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach Amazon EC2 Instance(s) to Your Existing 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginAttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachInstances operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndAttachInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachInstances.</param> <returns>Returns a AttachInstancesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CompleteLifecycleAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteLifecycleAction operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndCompleteLifecycleAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CompleteLifecycleAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCompleteLifecycleAction.</param> <returns>Returns a CompleteLifecycleActionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest)"> <summary> Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls. <note> The Auto Scaling group name must be unique within the scope of your AWS account. </note> </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndCreateAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAutoScalingGroup.</param> <returns>Returns a CreateAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest)"> <summary> Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use. </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLaunchConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndCreateLaunchConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLaunchConfiguration.</param> <returns>Returns a CreateLaunchConfigurationResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest)"> <summary> Creates new tags or updates existing tags for an Auto Scaling group. <note> A tag's definition is composed of a resource ID, resource type, key and value, and the propagate flag. Value and the propagate flag are optional parameters. See the Request Parameters for more information. </note> <para> For information on creating tags for your Auto Scaling group, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tag Your Auto Scaling Groups and Amazon EC2 Instances</a>. </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateOrUpdateTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateOrUpdateTags operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndCreateOrUpdateTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateOrUpdateTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateOrUpdateTags.</param> <returns>Returns a CreateOrUpdateTagsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest)"> <summary> Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress. <note> To remove all instances before calling <a>DeleteAutoScalingGroup</a>, you can call <a>UpdateAutoScalingGroup</a> to set the minimum and maximum size of the AutoScalingGroup to zero. </note> </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.ResourceInUseException"> This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used. </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDeleteAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAutoScalingGroup.</param> <returns>Returns a DeleteAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest)"> <summary> Deletes the specified <a>LaunchConfiguration</a>. <para> The specified 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.ResourceInUseException"> This is returned when you cannot delete a launch configuration or Auto Scaling group because it is being used. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLaunchConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDeleteLaunchConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLaunchConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLaunchConfiguration.</param> <returns>Returns a DeleteLaunchConfigurationResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLifecycleHook operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDeleteLifecycleHook(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLifecycleHook.</param> <returns>Returns a DeleteLifecycleHookResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest)"> <summary> Deletes notifications created by <a>PutNotificationConfiguration</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNotificationConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDeleteNotificationConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNotificationConfiguration.</param> <returns>Returns a DeleteNotificationConfigurationResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest)"> <summary> Deletes a policy created by <a>PutScalingPolicy</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePolicy operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDeletePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePolicy.</param> <returns>Returns a DeletePolicyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest)"> <summary> Deletes a scheduled action previously created using the <a>PutScheduledUpdateGroupAction</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteScheduledAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteScheduledAction operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDeleteScheduledAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteScheduledAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteScheduledAction.</param> <returns>Returns a DeleteScheduledActionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest)"> <summary> Removes the specified tags or a set of tags from a set of resources. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTags operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDeleteTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTags.</param> <returns>Returns a DeleteTagsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAccountLimits"> <summary> Returns the limits for the Auto Scaling resources currently allowed for your AWS account. <para> Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of <code>20</code> Auto Scaling groups and <code>100</code> launch configurations per region. </para> <para> If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the <a href="https://aws.amazon.com/support/">Support Center</a> and place a request to raise the limits. </para> </summary> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest)"> <summary> Returns the limits for the Auto Scaling resources currently allowed for your AWS account. <para> Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of <code>20</code> Auto Scaling groups and <code>100</code> launch configurations per region. </para> <para> If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the <a href="https://aws.amazon.com/support/">Support Center</a> and place a request to raise the limits. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAccountLimits operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeAccountLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAccountLimits operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAccountLimits.</param> <returns>Returns a DescribeAccountLimitsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAdjustmentTypes"> <summary> Returns policy adjustment types for use in the <a>PutScalingPolicy</a> action. </summary> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest)"> <summary> Returns policy adjustment types for use in the <a>PutScalingPolicy</a> action. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAdjustmentTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAdjustmentTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeAdjustmentTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAdjustmentTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAdjustmentTypes.</param> <returns>Returns a DescribeAdjustmentTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingGroups"> <summary> Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest)"> <summary> Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingGroups operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAutoScalingGroups operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeAutoScalingGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingGroups operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAutoScalingGroups.</param> <returns>Returns a DescribeAutoScalingGroupsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingInstances"> <summary> Returns a description of each Auto Scaling instance in the <code>InstanceIds</code> list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest)"> <summary> Returns a description of each Auto Scaling instance in the <code>InstanceIds</code> list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAutoScalingInstances operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeAutoScalingInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAutoScalingInstances.</param> <returns>Returns a DescribeAutoScalingInstancesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingNotificationTypes"> <summary> Returns a list of all notification types that are supported by Auto Scaling. </summary> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest)"> <summary> Returns a list of all 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAutoScalingNotificationTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeAutoScalingNotificationTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAutoScalingNotificationTypes.</param> <returns>Returns a DescribeAutoScalingNotificationTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLaunchConfigurations"> <summary> Returns a full description of the launch configurations, or the specified launch configurations, if they exist. <para> If no name is specified, then the full details of all launch configurations are returned. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest)"> <summary> Returns a full description of the launch configurations, or the specified launch configurations, if they exist. <para> If no name is specified, then the full details of all launch configurations are returned. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLaunchConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLaunchConfigurations operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeLaunchConfigurations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLaunchConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLaunchConfigurations.</param> <returns>Returns a DescribeLaunchConfigurationsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHooks operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLifecycleHooks operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeLifecycleHooks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLifecycleHooks operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLifecycleHooks.</param> <returns>Returns a DescribeLifecycleHooksResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLifecycleHookTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeLifecycleHookTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLifecycleHookTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLifecycleHookTypes.</param> <returns>Returns a DescribeLifecycleHookTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeMetricCollectionTypes"> <summary> Returns a list of metrics and a corresponding list of granularities for each metric. </summary> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest)"> <summary> Returns a list of metrics and a corresponding list of granularities for each metric. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMetricCollectionTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeMetricCollectionTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeMetricCollectionTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeMetricCollectionTypes.</param> <returns>Returns a DescribeMetricCollectionTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeNotificationConfigurations"> <summary> Returns a list of notification actions associated with Auto Scaling groups for specified events. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest)"> <summary> Returns a list of notification actions associated with Auto Scaling groups for specified events. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNotificationConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNotificationConfigurations operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeNotificationConfigurations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNotificationConfigurations operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNotificationConfigurations.</param> <returns>Returns a DescribeNotificationConfigurationsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribePolicies"> <summary> Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest)"> <summary> Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePolicies operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePolicies operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribePolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePolicies operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePolicies.</param> <returns>Returns a DescribePoliciesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingActivities"> <summary> Returns the scaling activities for the specified Auto Scaling group. <para> If the specified <code>ActivityIds</code> list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list. </para> <para> This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest)"> <summary> Returns the scaling activities for the specified Auto Scaling group. <para> If the specified <code>ActivityIds</code> list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list. </para> <para> This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </para> </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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingActivities operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScalingActivities operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeScalingActivities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingActivities operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingActivities.</param> <returns>Returns a DescribeScalingActivitiesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingProcessTypes"> <summary> Returns scaling process types for use in the <a>ResumeProcesses</a> and <a>SuspendProcesses</a> actions. </summary> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest)"> <summary> Returns scaling process types for use in the <a>ResumeProcesses</a> and <a>SuspendProcesses</a> actions. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingProcessTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScalingProcessTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeScalingProcessTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingProcessTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingProcessTypes.</param> <returns>Returns a DescribeScalingProcessTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScheduledActions"> <summary> Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in <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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest)"> <summary> Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in <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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScheduledActions operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScheduledActions operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeScheduledActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScheduledActions operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScheduledActions.</param> <returns>Returns a DescribeScheduledActionsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTags"> <summary> Lists the Auto Scaling group tags. <para> You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your 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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest)"> <summary> Lists the Auto Scaling group tags. <para> You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your 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 invalid. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTags operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTags operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTags.</param> <returns>Returns a DescribeTagsResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTerminationPolicyTypes"> <summary> Returns a list of all termination policies supported by Auto Scaling. </summary> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest)"> <summary> Returns a list of all 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTerminationPolicyTypes operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeTerminationPolicyTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTerminationPolicyTypes operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTerminationPolicyTypes.</param> <returns>Returns a DescribeTerminationPolicyTypesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachInstances operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDetachInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachInstances operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachInstances.</param> <returns>Returns a DetachInstancesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest)"> <summary> Disables monitoring of group metrics for the Auto Scaling group specified in <code>AutoScalingGroupName</code>. You can specify the list of affected metrics with the <code>Metrics</code> parameter. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableMetricsCollection operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDisableMetricsCollection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableMetricsCollection.</param> <returns>Returns a DisableMetricsCollectionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest)"> <summary> Enables monitoring of group metrics for the Auto Scaling group specified in <code>AutoScalingGroupName</code>. You can specify the list of enabled metrics with the <code>Metrics</code> parameter. <para> Auto Scaling metrics collection can be turned on only if the <code>InstanceMonitoring</code> flag, in the Auto Scaling group's launch configuration, 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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginEnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableMetricsCollection operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndEnableMetricsCollection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableMetricsCollection operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableMetricsCollection.</param> <returns>Returns a EnableMetricsCollectionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginEnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnterStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnterStandby operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndEnterStandby(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnterStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnterStandby.</param> <returns>Returns a EnterStandbyResult from AutoScaling.</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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginExecutePolicy(Amazon.AutoScaling.Model.ExecutePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecutePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the ExecutePolicy operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecutePolicy operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndExecutePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExecutePolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecutePolicy.</param> <returns>Returns a ExecutePolicyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExitStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExitStandby operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndExitStandby(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExitStandby operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExitStandby.</param> <returns>Returns a ExitStandbyResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.PutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLifecycleHook operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndPutLifecycleHook(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutLifecycleHook operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutLifecycleHook.</param> <returns>Returns a PutLifecycleHookResult from AutoScaling.</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">Get Email Notifications When Your Auto Scaling Group Changes</a> </para> <para> A new <code>PutNotificationConfiguration</code> 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"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutNotificationConfiguration(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutNotificationConfiguration operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndPutNotificationConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutNotificationConfiguration operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutNotificationConfiguration.</param> <returns>Returns a PutNotificationConfigurationResult from AutoScaling.</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 parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. </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"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutScalingPolicy(Amazon.AutoScaling.Model.PutScalingPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScalingPolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutScalingPolicy operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndPutScalingPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutScalingPolicy operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutScalingPolicy.</param> <returns>Returns a PutScalingPolicyResult from AutoScaling.</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 information on creating or updating a scheduled action for your Auto Scaling group, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scale Based on a Schedule</a>. </para> <note> <para> Auto Scaling supports the date and time expressed in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only. </para> </note> </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"> The named Auto Scaling group or launch configuration already exists. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> The quota for capacity groups or launch configurations for this customer has already been reached. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutScheduledUpdateGroupAction(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutScheduledUpdateGroupAction operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndPutScheduledUpdateGroupAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutScheduledUpdateGroupAction operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutScheduledUpdateGroupAction.</param> <returns>Returns a PutScheduledUpdateGroupActionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.RecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest)"> <summary> </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginRecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRecordLifecycleActionHeartbeat operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndRecordLifecycleActionHeartbeat(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RecordLifecycleActionHeartbeat operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRecordLifecycleActionHeartbeat.</param> <returns>Returns a RecordLifecycleActionHeartbeatResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.ResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest)"> <summary> Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Process</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResumeProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResumeProcesses operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndResumeProcesses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResumeProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResumeProcesses.</param> <returns>Returns a ResumeProcessesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest)"> <summary> Sets the desired size of the specified <a>AutoScalingGroup</a>. </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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginSetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetDesiredCapacity operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetDesiredCapacity operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndSetDesiredCapacity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetDesiredCapacity operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetDesiredCapacity.</param> <returns>Returns a SetDesiredCapacityResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest)"> <summary> Sets the health status of a specified instance that belongs to any of your Auto Scaling groups. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-configure-healthcheck.html">Configure Health Checks for Your Auto Scaling group</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginSetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetInstanceHealth operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetInstanceHealth operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndSetInstanceHealth(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetInstanceHealth operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetInstanceHealth.</param> <returns>Returns a SetInstanceHealthResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest)"> <summary> Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the <code>ScalingProcesses.member.N</code> parameter. To suspend all process types, omit the <code>ScalingProcesses.member.N</code> parameter. <important> <para> Suspending either of the two primary process types, <code>Launch</code> or <code>Terminate</code>, can prevent other process types from functioning properly. </para> </important> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a> For more information on suspending and resuming Auto Scaling process, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Process</a>. </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> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginSuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SuspendProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSuspendProcesses operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndSuspendProcesses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SuspendProcesses operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSuspendProcesses.</param> <returns>Returns a SuspendProcessesResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.TerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest)"> <summary> Terminates the specified instance. Optionally, the desired group size can be adjusted. <note> This call simply registers a termination request. The termination of the instance cannot happen immediately. </note> </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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginTerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateInstanceInAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndTerminateInstanceInAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateInstanceInAutoScalingGroup.</param> <returns>Returns a TerminateInstanceInAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.UpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest)"> <summary> Updates the configuration for the specified <a>AutoScalingGroup</a>. <note> <para> To update an Auto Scaling group with a launch configuration that has the <code>InstanceMonitoring</code> flag set to <code>False</code>, you must first ensure that collection of group metrics is disabled. Otherwise, calls to <a>UpdateAutoScalingGroup</a> will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling <a>DisableMetricsCollection</a>. </para> </note> <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> <note> <ul> <li> <para> If a new value is specified for <i>MinSize</i> without specifying the value for <i>DesiredCapacity</i>, and if the new <i>MinSize</i> is larger than the current size of the Auto Scaling Group, there will be an implicit call to <a>SetDesiredCapacity</a> to set the group to the new <i>MinSize</i>. </para> </li> <li> <para> If a new value is specified for <i>MaxSize</i> without specifying the value for <i>DesiredCapacity</i>, and the new <i>MaxSize</i> is smaller than the current size of the Auto Scaling Group, there will be an implicit call to <a>SetDesiredCapacity</a> to set the group to the new <i>MaxSize</i>. </para> </li> <li> <para> All other optional parameters are left unchanged if not passed in the request. </para> </li> </ul> </note> </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.ScalingActivityInProgressException"> You cannot delete an Auto Scaling group while there are scaling activities in progress for that group. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginUpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup operation on AmazonAutoScalingClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAutoScalingGroup operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndUpdateAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAutoScalingGroup operation. <seealso cref="T:Amazon.AutoScaling.AmazonAutoScaling"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAutoScalingGroup.</param> <returns>Returns a UpdateAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="T:Amazon.AutoScaling.AmazonAutoScalingConfig"> <summary> Configuration for accessing Amazon AutoScaling service </summary> </member> <member name="T:Amazon.Runtime.ClientConfig"> <summary> This class is the base class of all the configurations settings to connect to a service. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ServiceVersion"> <summary> Gets Service Version </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.SignatureMethod"> <summary> Gets and sets of the signatureMethod property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.SignatureVersion"> <summary> Gets and sets of the SignatureVersion property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.UserAgent"> <summary> Gets and sets of the UserAgent property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.RegionEndpoint"> <summary> Gets and sets the RegionEndpoint property. This value is the region constant that determines the service endpoint to use. If this value is not set, then the client will use the value of ServiceURL. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.Protocol"> <summary> Network protocol to use with the request. This value is ignored if the ServiceURL is specified or if RegionEndpoint is set and the service/endpoint does not support the specified protocol. Default is HTTPS. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ServiceURL"> <summary> Gets and sets the ServiceURL property. This value specifies the endpoint to access with the client. ServiceURL is ignored if RegionEndpoint is set. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.AuthenticationRegion"> <summary> Gets and sets the AuthenticationRegion property. Used in AWS4 request signing, this is an optional property; change it only if the region cannot be determined from the service endpoint. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.AuthenticationServiceName"> <summary> Gets and sets the AuthenticationServiceName property. Used in AWS4 request signing, this is the short-form name of the service being called. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyHost"> <summary> Gets and sets of the ProxyHost property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyPort"> <summary> Gets and sets of the ProxyPort property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.MaxErrorRetry"> <summary> Gets and sets of the MaxErrorRetry property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.UseSecureStringForAwsSecretKey"> <summary> Gets and Sets the UseSecureStringForAwsSecretKey property. By default, the AWS Secret Access Key is stored in a SecureString (true) - this is one of the secure ways to store a secret provided by the .NET Framework. But, the use of SecureStrings is not supported in Medium Trust Windows Hosting environments. If you are building an ASP.NET application that needs to run with Medium Trust, set this property to false, and the client will not save your AWS Secret Key in a secure string. Changing the default to false can result in the Secret Key being vulnerable; please use this property judiciously. </summary> <remarks>Storing the AWS Secret Access Key is not recommended unless absolutely necessary. </remarks> <seealso cref="T:System.Security.SecureString"/> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyUsername"> <summary> Gets and sets the ProxyUsername property. Used in conjunction with the ProxyPassword property to authenticate requests with the specified Proxy server. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyPassword"> <summary> Gets and sets the ProxyPassword property. Used in conjunction with the ProxyUsername property to authenticate requests with the specified Proxy server. </summary> <remarks> If this property isn't set, String.Empty is used as the proxy password. This property isn't used if ProxyUsername is null or empty. </remarks> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyCredentials"> <summary> Credentials to use with a proxy. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.LogResponse"> <summary> Gets and sets the LogResponse. If this property is set to true, the service response is read in its entirety and logged. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ConnectionLimit"> <summary> Gets and sets the connection limit set on the ServicePoint for the WebRequest. Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in which case ServicePointManager.DefaultConnectionLimit will be used as the default. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.UseNagleAlgorithm"> <summary> Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite default then ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ReadEntireResponse"> <summary> Gets and sets the ReadEntireResponse. If this property is set to true, the service response is read in its entirety before being processed. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.BufferSize"> <summary> Gets and Sets the BufferSize property. The BufferSize controls the buffer used to read in from input streams and write out to the request. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ResignRetries"> <summary> Flag on whether to resign requests on retry or not. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.LogMetrics"> <summary> Flag on whether to log metrics for service calls. This can be set in the application's configs, as below: <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSLogMetrics" value"true"/> </appSettings> </configuration> </code> </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.DisableLogging"> <summary> Flag on whether to completely disable logging for this client or not. </summary> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.AutoScaling.AmazonAutoScalingConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.AutoScaling.AmazonAutoScalingConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.Runtime.AmazonServiceException"> <summary> A base exception for some Amazon Web Services. <para> Most exceptions thrown to client code will be service-specific exceptions, though some services may throw this exception if there is a problem which is caught in the core client code. </para> </summary> </member> <member name="P:Amazon.Runtime.AmazonServiceException.ErrorType"> <summary> Whether the error was attributable to <c>Sender</c> or <c>Reciever</c>. </summary> </member> <member name="P:Amazon.Runtime.AmazonServiceException.ErrorCode"> <summary> The error code returned by the service </summary> </member> <member name="P:Amazon.Runtime.AmazonServiceException.RequestId"> <summary> The id of the request which generated the exception. </summary> </member> <member name="P:Amazon.Runtime.AmazonServiceException.StatusCode"> <summary> The HTTP status code from the service response </summary> </member> <member name="T:Amazon.AutoScaling.Model.Activity"> <summary> A scaling Activity is a long-running process that represents a change to your AutoScalingGroup, such as changing the size of the group. It can also be a process to replace an instance, or a process to perform any other long-running operations supported by the API. </summary> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithActivityId(System.String)"> <summary> Sets the ActivityId property </summary> <param name="activityId">The value to set for the ActivityId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithCause(System.String)"> <summary> Sets the Cause property </summary> <param name="cause">The value to set for the Cause property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithDetails(System.String)"> <summary> Sets the Details property </summary> <param name="details">The value to set for the Details property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithEndTime(System.DateTime)"> <summary> Sets the EndTime property </summary> <param name="endTime">The value to set for the EndTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithProgress(System.Int32)"> <summary> Sets the Progress property </summary> <param name="progress">The value to set for the Progress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithStatusCode(System.String)"> <summary> Sets the StatusCode property </summary> <param name="statusCode">The value to set for the StatusCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Activity.WithStatusMessage(System.String)"> <summary> Sets the StatusMessage property </summary> <param name="statusMessage">The value to set for the StatusMessage property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.Activity.ActivityId"> <summary> Gets and sets the property ActivityId. <para> Specifies the ID of the activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.Cause"> <summary> Gets and sets the property Cause. <para> Contains the reason the activity was begun. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.Description"> <summary> Gets and sets the property Description. <para> Contains a friendly, more verbose description of the scaling activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.Details"> <summary> Gets and sets the property Details. <para> Contains details of the scaling activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.EndTime"> <summary> Gets and sets the property EndTime. <para> Provides the end time of this activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.Progress"> <summary> Gets and sets the property Progress. <para> Specifies a value between 0 and 100 that indicates the progress of the activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.StartTime"> <summary> Gets and sets the property StartTime. <para> Provides the start time of this activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.StatusCode"> <summary> Gets and sets the property StatusCode. <para> Contains the current status of the activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> Contains a friendly, more verbose description of the activity status. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.AdjustmentType"> <summary> Specifies whether the <a>PutScalingPolicy</a> <code>ScalingAdjustment</code> parameter is an absolute number or a percentage of the current capacity. </summary> </member> <member name="M:Amazon.AutoScaling.Model.AdjustmentType.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="adjustmentType">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.AdjustmentType.Name"> <summary> Gets and sets the property Name. <para> A policy adjustment type. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.Alarm"> <summary> The Alarm data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.Alarm.WithAlarmARN(System.String)"> <summary> Sets the AlarmARN property </summary> <param name="alarmARN">The value to set for the AlarmARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Alarm.WithAlarmName(System.String)"> <summary> Sets the AlarmName property </summary> <param name="alarmName">The value to set for the AlarmName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.Alarm.AlarmARN"> <summary> Gets and sets the property AlarmARN. <para> The Amazon Resource Name (ARN) of the alarm. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Alarm.AlarmName"> <summary> Gets and sets the property AlarmName. <para> The name of the alarm. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.AlreadyExistsException"> <summary> AutoScaling exception </summary> </member> <member name="M:Amazon.AutoScaling.Model.AlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new AlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AutoScaling.Model.AttachInstancesRequest"> <summary> Container for the parameters to the AttachInstances operation. Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach Amazon EC2 Instance(s) to Your Existing Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.Runtime.AmazonWebServiceRequest"> <summary> Base class for request used by some of the services. </summary> </member> <member name="M:Amazon.AutoScaling.Model.AttachInstancesRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AttachInstancesRequest.WithInstanceIds(System.String[])"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AttachInstancesRequest.WithInstanceIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.AttachInstancesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group to which to attach the specified instance(s). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AttachInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more IDs of the Amazon EC2 instances to attach to the specified Auto Scaling group. You must specify at least one instance ID. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.AttachInstancesResponse"> <summary> Returns information about the AttachInstancesResult response and response metadata. </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="T:Amazon.AutoScaling.Model.AutoScalingGroup"> <summary> The AutoScalingGroup data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithAutoScalingGroupARN(System.String)"> <summary> Sets the AutoScalingGroupARN property </summary> <param name="autoScalingGroupARN">The value to set for the AutoScalingGroupARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithAvailabilityZones(System.String[])"> <summary> Sets the AvailabilityZones property </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the AvailabilityZones property </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithCreatedTime(System.DateTime)"> <summary> Sets the CreatedTime property </summary> <param name="createdTime">The value to set for the CreatedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithDefaultCooldown(System.Int32)"> <summary> Sets the DefaultCooldown property </summary> <param name="defaultCooldown">The value to set for the DefaultCooldown property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithDesiredCapacity(System.Int32)"> <summary> Sets the DesiredCapacity property </summary> <param name="desiredCapacity">The value to set for the DesiredCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithEnabledMetrics(Amazon.AutoScaling.Model.EnabledMetric[])"> <summary> Sets the EnabledMetrics property </summary> <param name="enabledMetrics">The values to add to the EnabledMetrics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithEnabledMetrics(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.EnabledMetric})"> <summary> Sets the EnabledMetrics property </summary> <param name="enabledMetrics">The values to add to the EnabledMetrics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithHealthCheckGracePeriod(System.Int32)"> <summary> Sets the HealthCheckGracePeriod property </summary> <param name="healthCheckGracePeriod">The value to set for the HealthCheckGracePeriod property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithHealthCheckType(System.String)"> <summary> Sets the HealthCheckType property </summary> <param name="healthCheckType">The value to set for the HealthCheckType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithInstances(Amazon.AutoScaling.Model.Instance[])"> <summary> Sets the Instances property </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithInstances(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Instance})"> <summary> Sets the Instances property </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithLoadBalancerNames(System.String[])"> <summary> Sets the LoadBalancerNames property </summary> <param name="loadBalancerNames">The values to add to the LoadBalancerNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithLoadBalancerNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the LoadBalancerNames property </summary> <param name="loadBalancerNames">The values to add to the LoadBalancerNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithMaxSize(System.Int32)"> <summary> Sets the MaxSize property </summary> <param name="maxSize">The value to set for the MaxSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithMinSize(System.Int32)"> <summary> Sets the MinSize property </summary> <param name="minSize">The value to set for the MinSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithPlacementGroup(System.String)"> <summary> Sets the PlacementGroup property </summary> <param name="placementGroup">The value to set for the PlacementGroup property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithSuspendedProcesses(Amazon.AutoScaling.Model.SuspendedProcess[])"> <summary> Sets the SuspendedProcesses property </summary> <param name="suspendedProcesses">The values to add to the SuspendedProcesses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithSuspendedProcesses(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.SuspendedProcess})"> <summary> Sets the SuspendedProcesses property </summary> <param name="suspendedProcesses">The values to add to the SuspendedProcesses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithTags(Amazon.AutoScaling.Model.TagDescription[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithTags(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.TagDescription})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithTerminationPolicies(System.String[])"> <summary> Sets the TerminationPolicies property </summary> <param name="terminationPolicies">The values to add to the TerminationPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithTerminationPolicies(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the TerminationPolicies property </summary> <param name="terminationPolicies">The values to add to the TerminationPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingGroup.WithVPCZoneIdentifier(System.String)"> <summary> Sets the VPCZoneIdentifier property </summary> <param name="vPCZoneIdentifier">The value to set for the VPCZoneIdentifier property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.AutoScalingGroupARN"> <summary> Gets and sets the property AutoScalingGroupARN. <para> The Amazon Resource Name (ARN) of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> Specifies the name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> Contains a list of Availability Zones for the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.CreatedTime"> <summary> Gets and sets the property CreatedTime. <para> Specifies the date and time the Auto Scaling group was created. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.DefaultCooldown"> <summary> Gets and sets the property DefaultCooldown. <para> The number of seconds after a scaling activity completes before any further scaling activities can start. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> Specifies the desired capacity for the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.EnabledMetrics"> <summary> Gets and sets the property EnabledMetrics. <para> A list of metrics enabled for this Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.HealthCheckGracePeriod"> <summary> Gets and sets the property HealthCheckGracePeriod. <para> The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.HealthCheckType"> <summary> Gets and sets the property HealthCheckType. <para> The service of interest for the health status check, either "EC2" for Amazon EC2 or "ELB" for Elastic Load Balancing. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.Instances"> <summary> Gets and sets the property Instances. <para> Provides a summary list of Amazon EC2 instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> Specifies the name of the associated <a>LaunchConfiguration</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.LoadBalancerNames"> <summary> Gets and sets the property LoadBalancerNames. <para> A list of load balancers associated with this Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.MaxSize"> <summary> Gets and sets the property MaxSize. <para> Contains the maximum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.MinSize"> <summary> Gets and sets the property MinSize. <para> Contains the minimum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.PlacementGroup"> <summary> Gets and sets the property PlacementGroup. <para> The name of the cluster placement group, if applicable. For more information, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html"> Using Cluster Instances</a> in the Amazon EC2 User Guide. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.Status"> <summary> Gets and sets the property Status. <para> The current state of the Auto Scaling group when a <a>DeleteAutoScalingGroup</a> action is in progress. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.SuspendedProcesses"> <summary> Gets and sets the property SuspendedProcesses. <para> Suspended processes associated with this Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.Tags"> <summary> Gets and sets the property Tags. <para> A list of tags for the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.TerminationPolicies"> <summary> Gets and sets the property TerminationPolicies. <para> A standalone termination policy or a list of termination policies for this Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.VPCZoneIdentifier"> <summary> Gets and sets the property VPCZoneIdentifier. <para> The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list. </para> <para> When you specify <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, ensure that the subnets' Availability Zones match the values you specify for <code>AvailabilityZones</code>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.AutoScalingInstanceDetails"> <summary> The <code>AutoScalingInstanceDetails</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.WithAvailabilityZone(System.String)"> <summary> Sets the AvailabilityZone property </summary> <param name="availabilityZone">The value to set for the AvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.WithHealthStatus(System.String)"> <summary> Sets the HealthStatus property </summary> <param name="healthStatus">The value to set for the HealthStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.WithLifecycleState(System.String)"> <summary> Sets the LifecycleState property </summary> <param name="lifecycleState">The value to set for the LifecycleState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group associated with this instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone in which this instance resides. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.HealthStatus"> <summary> Gets and sets the property HealthStatus. <para> The health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy. Auto Scaling should terminate and replace it. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The instance ID of the Amazon EC2 instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> The launch configuration associated with this instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.LifecycleState"> <summary> Gets and sets the property LifecycleState. <para> The life cycle state of this instance. for more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AS_Concepts.html#instance-lifecycle">Instance Lifecycle State</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.BlockDeviceMapping"> <summary> The <code>BlockDeviceMapping</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.BlockDeviceMapping.WithDeviceName(System.String)"> <summary> Sets the DeviceName property </summary> <param name="deviceName">The value to set for the DeviceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.BlockDeviceMapping.WithEbs(Amazon.AutoScaling.Model.Ebs)"> <summary> Sets the Ebs property </summary> <param name="ebs">The value to set for the Ebs property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.BlockDeviceMapping.WithNoDevice(System.Boolean)"> <summary> Sets the NoDevice property </summary> <param name="noDevice">The value to set for the NoDevice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.BlockDeviceMapping.WithVirtualName(System.String)"> <summary> Sets the VirtualName property </summary> <param name="virtualName">The value to set for the VirtualName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.DeviceName"> <summary> Gets and sets the property DeviceName. <para> The name of the device within Amazon EC2 (for example, /dev/sdh or xvdh). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.Ebs"> <summary> Gets and sets the property Ebs. <para> The Elastic Block Storage volume information. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.NoDevice"> <summary> Gets and sets the property NoDevice. <para> Suppresses the device mapping. </para> <note>If <code>NoDevice</code> is set to <code>true</code> for the root device, the instance might fail the EC2 health check. Auto Scaling launches a replacement instance if the instance fails the health check.</note> </summary> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.VirtualName"> <summary> Gets and sets the property VirtualName. <para> The virtual name associated with the device. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest"> <summary> Container for the parameters to the CompleteLifecycleAction operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.WithLifecycleActionResult(System.String)"> <summary> Sets the LifecycleActionResult property </summary> <param name="lifecycleActionResult">The value to set for the LifecycleActionResult property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.WithLifecycleActionToken(System.String)"> <summary> Sets the LifecycleActionToken property </summary> <param name="lifecycleActionToken">The value to set for the LifecycleActionToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.WithLifecycleHookName(System.String)"> <summary> Sets the LifecycleHookName property </summary> <param name="lifecycleHookName">The value to set for the LifecycleHookName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.LifecycleActionResult"> <summary> Gets and sets the property LifecycleActionResult. </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.LifecycleActionToken"> <summary> Gets and sets the property LifecycleActionToken. </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. </summary> </member> <member name="T:Amazon.AutoScaling.Model.CompleteLifecycleActionResponse"> <summary> Returns information about the CompleteLifecycleActionResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionResponse.CompleteLifecycleActionResult"> <summary> Gets and sets the CompleteLifecycleActionResult property. Represents the output of a CompleteLifecycleAction operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.CompleteLifecycleActionResult"> <summary> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest"> <summary> Container for the parameters to the CreateAutoScalingGroup operation. Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls. <note> The Auto Scaling group name must be unique within the scope of your AWS account. </note> </summary> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithAvailabilityZones(System.String[])"> <summary> Sets the AvailabilityZones property </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the AvailabilityZones property </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithDefaultCooldown(System.Int32)"> <summary> Sets the DefaultCooldown property </summary> <param name="defaultCooldown">The value to set for the DefaultCooldown property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithDesiredCapacity(System.Int32)"> <summary> Sets the DesiredCapacity property </summary> <param name="desiredCapacity">The value to set for the DesiredCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithHealthCheckGracePeriod(System.Int32)"> <summary> Sets the HealthCheckGracePeriod property </summary> <param name="healthCheckGracePeriod">The value to set for the HealthCheckGracePeriod property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithHealthCheckType(System.String)"> <summary> Sets the HealthCheckType property </summary> <param name="healthCheckType">The value to set for the HealthCheckType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithLoadBalancerNames(System.String[])"> <summary> Sets the LoadBalancerNames property </summary> <param name="loadBalancerNames">The values to add to the LoadBalancerNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithLoadBalancerNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the LoadBalancerNames property </summary> <param name="loadBalancerNames">The values to add to the LoadBalancerNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithMaxSize(System.Int32)"> <summary> Sets the MaxSize property </summary> <param name="maxSize">The value to set for the MaxSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithMinSize(System.Int32)"> <summary> Sets the MinSize property </summary> <param name="minSize">The value to set for the MinSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithPlacementGroup(System.String)"> <summary> Sets the PlacementGroup property </summary> <param name="placementGroup">The value to set for the PlacementGroup property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithTags(Amazon.AutoScaling.Model.Tag[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithTags(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Tag})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithTerminationPolicies(System.String[])"> <summary> Sets the TerminationPolicies property </summary> <param name="terminationPolicies">The values to add to the TerminationPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithTerminationPolicies(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the TerminationPolicies property </summary> <param name="terminationPolicies">The values to add to the TerminationPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.WithVPCZoneIdentifier(System.String)"> <summary> Sets the VPCZoneIdentifier property </summary> <param name="vPCZoneIdentifier">The value to set for the VPCZoneIdentifier property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> A list of Availability Zones for the Auto Scaling group. This is required unless you have specified subnets. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.DefaultCooldown"> <summary> Gets and sets the property DefaultCooldown. <para> The amount of time, in seconds, between a successful scaling activity and the succeeding scaling activity. </para> <para> If a <code>DefaultCooldown</code> period is not specified, Auto Scaling uses the default value of 300 as the default cool down period for the Auto Scaling group. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AS_Concepts.html#Cooldown">Cooldown Period</a> </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The number of Amazon EC2 instances that should be running in the group. The desired capacity must be greater than or equal to the minimum size and less than or equal to the maximum size specified for the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.HealthCheckGracePeriod"> <summary> Gets and sets the property HealthCheckGracePeriod. <para> Length of time in seconds after a new Amazon EC2 instance comes into service that Auto Scaling starts checking its health. During this time any health check failure for the that instance is ignored. </para> <para> This is required if you are adding <code>ELB</code> health check. Frequently, new instances need to warm up, briefly, before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to match the expected startup period of your application. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.HealthCheckType"> <summary> Gets and sets the property HealthCheckType. <para> The service you want the health checks from, Amazon EC2 or Elastic Load Balancer. Valid values are <code>EC2</code> or <code>ELB</code>. </para> <para> By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AS_Concepts.html#healthcheck">Health Check</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this attribute if you want to create an Auto Scaling group using an EC2 instance instead of a launch configuration. </para> <para> When you use an instance to create an Auto Scaling group, a new launch configuration is first created and then associated with the Auto Scaling group. The new launch configuration derives all its attributes from the instance that is used to create the Auto Scaling group, with the exception of <code>BlockDeviceMapping</code>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-asg-from-instance.html">Create an Auto Scaling Group Using EC2 Instance</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> The name of an existing launch configuration to use to launch new instances. Use this attribute if you want to create an Auto Scaling group using an existing launch configuration instead of an EC2 instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.LoadBalancerNames"> <summary> Gets and sets the property LoadBalancerNames. <para> A list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account. </para> <para> For information on using load balancers, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SetUpASLBApp.html">Use Load Balancer to Load Balance Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.MaxSize"> <summary> Gets and sets the property MaxSize. <para> The maximum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.MinSize"> <summary> Gets and sets the property MinSize. <para> The minimum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.PlacementGroup"> <summary> Gets and sets the property PlacementGroup. <para> Physical location of an existing cluster placement group into which you want to launch your instances. For information about cluster placement group, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Using Cluster Instances</a> </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.Tags"> <summary> Gets and sets the property Tags. <para> The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values: key=<i>value</i>, value=<i>value</i>, propagate=<i>true</i> or <i>false</i>. Value and propagate are optional parameters. </para> <para> For information about using tags, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tag Your Auto Scaling Groups and Amazon EC2 Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.TerminationPolicies"> <summary> Gets and sets the property TerminationPolicies. <para> A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed. </para> <para> For more information on configuring a termination policy for your Auto Scaling group, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-termination-policy.html">Instance Termination Policy for Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.VPCZoneIdentifier"> <summary> Gets and sets the property VPCZoneIdentifier. <para> A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs). </para> <para> If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified. </para> <para> For information on launching your Auto Scaling group into Amazon VPC subnets, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html">Launch Auto Scaling Instances into Amazon VPC</a> in the <i>Auto Scaling Developer Guide</i> . </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateAutoScalingGroupResponse"> <summary> Returns information about the CreateAutoScalingGroupResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest"> <summary> Container for the parameters to the CreateLaunchConfiguration operation. Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use. </summary> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithAssociatePublicIpAddress(System.Boolean)"> <summary> Sets the AssociatePublicIpAddress property </summary> <param name="associatePublicIpAddress">The value to set for the AssociatePublicIpAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithBlockDeviceMappings(Amazon.AutoScaling.Model.BlockDeviceMapping[])"> <summary> Sets the BlockDeviceMappings property </summary> <param name="blockDeviceMappings">The values to add to the BlockDeviceMappings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithBlockDeviceMappings(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.BlockDeviceMapping})"> <summary> Sets the BlockDeviceMappings property </summary> <param name="blockDeviceMappings">The values to add to the BlockDeviceMappings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithEbsOptimized(System.Boolean)"> <summary> Sets the EbsOptimized property </summary> <param name="ebsOptimized">The value to set for the EbsOptimized property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithIamInstanceProfile(System.String)"> <summary> Sets the IamInstanceProfile property </summary> <param name="iamInstanceProfile">The value to set for the IamInstanceProfile property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithImageId(System.String)"> <summary> Sets the ImageId property </summary> <param name="imageId">The value to set for the ImageId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithInstanceMonitoring(Amazon.AutoScaling.Model.InstanceMonitoring)"> <summary> Sets the InstanceMonitoring property </summary> <param name="instanceMonitoring">The value to set for the InstanceMonitoring property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithInstanceType(System.String)"> <summary> Sets the InstanceType property </summary> <param name="instanceType">The value to set for the InstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithKernelId(System.String)"> <summary> Sets the KernelId property </summary> <param name="kernelId">The value to set for the KernelId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithKeyName(System.String)"> <summary> Sets the KeyName property </summary> <param name="keyName">The value to set for the KeyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithPlacementTenancy(System.String)"> <summary> Sets the PlacementTenancy property </summary> <param name="placementTenancy">The value to set for the PlacementTenancy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithRamdiskId(System.String)"> <summary> Sets the RamdiskId property </summary> <param name="ramdiskId">The value to set for the RamdiskId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithSecurityGroups(System.String[])"> <summary> Sets the SecurityGroups property </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithSecurityGroups(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the SecurityGroups property </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithSpotPrice(System.String)"> <summary> Sets the SpotPrice property </summary> <param name="spotPrice">The value to set for the SpotPrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.WithUserData(System.String)"> <summary> Sets the UserData property </summary> <param name="userData">The value to set for the UserData property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.AssociatePublicIpAddress"> <summary> Gets and sets the property AssociatePublicIpAddress. <para> Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). Specifies whether to assign a public IP address to each instance launched in a Amazon VPC. </para> <note> <para> If you specify a value for this parameter, be sure to specify at least one VPC subnet using the <i>VPCZoneIdentifier</i> parameter when you create your Auto Scaling group. </para> </note> <para> Default: If the instance is launched into a default subnet in a default VPC, the default is <code>true</code>. If the instance is launched into a nondefault subnet in a VPC, the default is <code>false</code>. For information about the platforms supported by Auto Scaling, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_BasicSetup.html">Get Started with Auto Scaling Using the Command Line Interface</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> A list of mappings that specify how block devices are exposed to the instance. Each mapping is made up of a <i>VirtualName</i>, a <i>DeviceName</i>, and an <i>ebs</i> data structure that contains information about the associated Elastic Block Storage volume. For more information about Amazon EC2 BlockDeviceMappings, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/index.html?block-device-mapping-concepts.html"> Block Device Mapping</a> in the Amazon EC2 product documentation. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Whether the instance is optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization is not available with all instance types. Additional usage charges apply when using an EBS Optimized instance. By default the instance is not optimized for EBS I/O. For information about EBS-optimized instances, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#EBSOptimized">EBS-Optimized Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. </para> <para> Amazon EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances to securely access other AWS resources. For information on launching EC2 instances with an IAM role, go to <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-iam-role.html">Launching Auto Scaling Instances With an IAM Role</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.ImageId"> <summary> Gets and sets the property ImageId. <para> Unique ID of the Amazon Machine Image (AMI) you want to use to launch your EC2 instances. For information about finding Amazon EC2 AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Finding a Suitable AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the Amazon EC2 instance you want to use to create the launch configuration. Use this attribute if you want the launch configuration to derive its attributes from an EC2 instance. </para> <para> When you use an instance to create a launch configuration, all you need to specify is the <code>InstanceId</code>. The new launch configuration, by default, derives all the attributes from the specified instance with the exception of <code>BlockDeviceMapping</code>. </para> <para> If you want to create a launch configuration with <code>BlockDeviceMapping</code> or override any other instance attributes, specify them as part of the same request. </para> <para> For more information on using an InstanceID to create a launch configuration, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-lc-with-instanceID.html">Create a Launch Configuration Using an Amazon EC2 Instance</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.InstanceMonitoring"> <summary> Gets and sets the property InstanceMonitoring. <para> Enables detailed monitoring if it is disabled. Detailed monitoring is enabled by default. </para> <para> When detailed monitoring is enabled, Amazon Cloudwatch will generate metrics every minute and your account will be charged a fee. When you disable detailed monitoring, by specifying <code>False</code>, Cloudwatch will generate metrics every 5 minutes. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-instance-monitoring.html">Monitor Your Auto Scaling Instances</a>. For information about Amazon CloudWatch, see the <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/Welcome.html">Amazon CloudWatch Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type of the Amazon EC2 instance. For information about available Amazon EC2 instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes"> Available Instance Types</a> in the <i>Amazon Elastic Cloud Compute User Guide.</i> </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.KernelId"> <summary> Gets and sets the property KernelId. <para> The ID of the kernel associated with the Amazon EC2 AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the Amazon EC2 key pair. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/generating-a-keypair.html">Getting a Key Pair</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> The name of the launch configuration to create. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.PlacementTenancy"> <summary> Gets and sets the property PlacementTenancy. <para> The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html">Auto Scaling in Amazon Virtual Private Cloud</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> Valid values: <code>default</code> | <code>dedicated</code> </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The ID of the RAM disk associated with the Amazon EC2 AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> The security groups with which to associate Amazon EC2 or Amazon VPC instances. </para> <para> If your instances are launched in EC2, you can either specify Amazon EC2 security group names or the security group IDs. For more information about Amazon EC2 security groups, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/index.html?using-network-security.html"> Using Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If your instances are launched within VPC, specify Amazon VPC security group IDs. For more information about Amazon VPC security groups, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/index.html?VPC_SecurityGroups.html">Security Groups</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.SpotPrice"> <summary> Gets and sets the property SpotPrice. <para> The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information on launching Spot Instances, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US-SpotInstances.html"> Using Auto Scaling to Launch Spot Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.UserData"> <summary> Gets and sets the property UserData. <para> The user data to make available to the launched Amazon EC2 instances. For more information about Amazon EC2 user data, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html#instancedata-user-data-retrieval">User Data Retrieval</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <note> At this time, Auto Scaling launch configurations don't support compressed (e.g. zipped) user data files. </note> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateLaunchConfigurationResponse"> <summary> Returns information about the CreateLaunchConfigurationResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest"> <summary> Container for the parameters to the CreateOrUpdateTags operation. Creates new tags or updates existing tags for an Auto Scaling group. <note> A tag's definition is composed of a resource ID, resource type, key and value, and the propagate flag. Value and the propagate flag are optional parameters. See the Request Parameters for more information. </note> <para> For information on creating tags for your Auto Scaling group, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tag Your Auto Scaling Groups and Amazon EC2 Instances</a>. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest.WithTags(Amazon.AutoScaling.Model.Tag[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest.WithTags(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Tag})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. The resource type and resource ID identify the type and name of resource for which the tag is created. Currently, <code>auto-scaling-group</code> is the only supported resource type. The valid value for the resource ID is <i>groupname</i>. </para> <para> The <code>PropagateAtLaunch</code> flag defines whether the new tag will be applied to instances launched by the Auto Scaling group. Valid values are <code>true</code> or <code>false</code>. However, instances that are already running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be applied only to new instances launched by the Auto Scaling group after the change. Running instances that had the previous version of the tag will continue to have the older tag. </para> <para> When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateOrUpdateTagsResponse"> <summary> Returns information about the CreateOrUpdateTagsResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest"> <summary> Container for the parameters to the DeleteAutoScalingGroup operation. Deletes the specified Auto Scaling group if the group has no instances and no scaling activities in progress. <note> To remove all instances before calling <a>DeleteAutoScalingGroup</a>, you can call <a>UpdateAutoScalingGroup</a> to set the minimum and maximum size of the AutoScalingGroup to zero. </note> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest.WithForceDelete(System.Boolean)"> <summary> Sets the ForceDelete property </summary> <param name="forceDelete">The value to set for the ForceDelete property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group to delete. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest.ForceDelete"> <summary> Gets and sets the property ForceDelete. <para> Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteAutoScalingGroupResponse"> <summary> Returns information about the DeleteAutoScalingGroupResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest"> <summary> Container for the parameters to the DeleteLaunchConfiguration operation. Deletes the specified <a>LaunchConfiguration</a>. <para> The specified 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> </member> <member name="M:Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> The name of the launch configuration. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLaunchConfigurationResponse"> <summary> Returns information about the DeleteLaunchConfigurationResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLifecycleHookRequest"> <summary> Container for the parameters to the DeleteLifecycleHook operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DeleteLifecycleHookRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DeleteLifecycleHookRequest.WithLifecycleHookName(System.String)"> <summary> Sets the LifecycleHookName property </summary> <param name="lifecycleHookName">The value to set for the LifecycleHookName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DeleteLifecycleHookRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteLifecycleHookRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLifecycleHookResponse"> <summary> Returns information about the DeleteLifecycleHookResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteLifecycleHookResponse.DeleteLifecycleHookResult"> <summary> Gets and sets the DeleteLifecycleHookResult property. Represents the output of a DeleteLifecycleHook operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLifecycleHookResult"> <summary> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest"> <summary> Container for the parameters to the DeleteNotificationConfiguration operation. Deletes notifications created by <a>PutNotificationConfiguration</a>. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest.WithTopicARN(System.String)"> <summary> Sets the TopicARN property </summary> <param name="topicARN">The value to set for the TopicARN property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest.TopicARN"> <summary> Gets and sets the property TopicARN. <para> The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteNotificationConfigurationResponse"> <summary> Returns information about the DeleteNotificationConfigurationResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeletePolicyRequest"> <summary> Container for the parameters to the DeletePolicy operation. Deletes a policy created by <a>PutScalingPolicy</a>. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DeletePolicyRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DeletePolicyRequest.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DeletePolicyRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeletePolicyRequest.PolicyName"> <summary> Gets and sets the property PolicyName. <para> The name or PolicyARN of the policy you want to delete. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeletePolicyResponse"> <summary> Returns information about the DeletePolicyResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteScheduledActionRequest"> <summary> Container for the parameters to the DeleteScheduledAction operation. Deletes a scheduled action previously created using the <a>PutScheduledUpdateGroupAction</a>. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DeleteScheduledActionRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DeleteScheduledActionRequest.WithScheduledActionName(System.String)"> <summary> Sets the ScheduledActionName property </summary> <param name="scheduledActionName">The value to set for the ScheduledActionName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DeleteScheduledActionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteScheduledActionRequest.ScheduledActionName"> <summary> Gets and sets the property ScheduledActionName. <para> The name of the action you want to delete. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteScheduledActionResponse"> <summary> Returns information about the DeleteScheduledActionResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteTagsRequest"> <summary> Container for the parameters to the DeleteTags operation. Removes the specified tags or a set of tags from a set of resources. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DeleteTagsRequest.WithTags(Amazon.AutoScaling.Model.Tag[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DeleteTagsRequest.WithTags(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Tag})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DeleteTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. Valid values are: Resource type = <i>auto-scaling-group</i>, Resource ID = <i>AutoScalingGroupName</i>, key=<i>value</i>, value=<i>value</i>, propagate=<i>true</i> or <i>false</i>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteTagsResponse"> <summary> Returns information about the DeleteTagsResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAccountLimitsRequest"> <summary> Container for the parameters to the DescribeAccountLimits operation. Returns the limits for the Auto Scaling resources currently allowed for your AWS account. <para> Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of <code>20</code> Auto Scaling groups and <code>100</code> launch configurations per region. </para> <para> If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the <a href="https://aws.amazon.com/support/">Support Center</a> and place a request to raise the limits. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAccountLimitsResponse"> <summary> Returns information about the DescribeAccountLimitsResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAccountLimitsResponse.DescribeAccountLimitsResult"> <summary> Gets and sets the DescribeAccountLimitsResult property. Represents the output of a DescribeAccountLimits operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAccountLimitsResult"> <summary> The output of the <a>DescribeAccountLimitsResult</a> action. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAccountLimitsResult.WithMaxNumberOfAutoScalingGroups(System.Int32)"> <summary> Sets the MaxNumberOfAutoScalingGroups property </summary> <param name="maxNumberOfAutoScalingGroups">The value to set for the MaxNumberOfAutoScalingGroups property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAccountLimitsResult.WithMaxNumberOfLaunchConfigurations(System.Int32)"> <summary> Sets the MaxNumberOfLaunchConfigurations property </summary> <param name="maxNumberOfLaunchConfigurations">The value to set for the MaxNumberOfLaunchConfigurations property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAccountLimitsResult.MaxNumberOfAutoScalingGroups"> <summary> Gets and sets the property MaxNumberOfAutoScalingGroups. <para> The maximum number of Auto Scaling groups allowed for your AWS account. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAccountLimitsResult.MaxNumberOfLaunchConfigurations"> <summary> Gets and sets the property MaxNumberOfLaunchConfigurations. <para> The maximum number of launch configurations allowed for your AWS account. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest"> <summary> Container for the parameters to the DescribeAdjustmentTypes operation. Returns policy adjustment types for use in the <a>PutScalingPolicy</a> action. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResponse"> <summary> Returns information about the DescribeAdjustmentTypesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResponse.DescribeAdjustmentTypesResult"> <summary> Gets and sets the DescribeAdjustmentTypesResult property. Represents the output of a DescribeAdjustmentTypes operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResult"> <summary> The output of the <a>DescribeAdjustmentTypes</a> action. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResult.WithAdjustmentTypes(Amazon.AutoScaling.Model.AdjustmentType[])"> <summary> Sets the AdjustmentTypes property </summary> <param name="adjustmentTypes">The values to add to the AdjustmentTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResult.WithAdjustmentTypes(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.AdjustmentType})"> <summary> Sets the AdjustmentTypes property </summary> <param name="adjustmentTypes">The values to add to the AdjustmentTypes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResult.AdjustmentTypes"> <summary> Gets and sets the property AdjustmentTypes. <para> A list of specific policy adjustment types. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest"> <summary> Container for the parameters to the DescribeAutoScalingGroups operation. Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.WithAutoScalingGroupNames(System.String[])"> <summary> Sets the AutoScalingGroupNames property </summary> <param name="autoScalingGroupNames">The values to add to the AutoScalingGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.WithAutoScalingGroupNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the AutoScalingGroupNames property </summary> <param name="autoScalingGroupNames">The values to add to the AutoScalingGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.AutoScalingGroupNames"> <summary> Gets and sets the property AutoScalingGroupNames. <para> A list of Auto Scaling group names. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of records to return. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResponse"> <summary> Returns information about the DescribeAutoScalingGroupsResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResponse.DescribeAutoScalingGroupsResult"> <summary> Gets and sets the DescribeAutoScalingGroupsResult property. Represents the output of a DescribeAutoScalingGroups operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult"> <summary> The <code>AutoScalingGroupsType</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult.WithAutoScalingGroups(Amazon.AutoScaling.Model.AutoScalingGroup[])"> <summary> Sets the AutoScalingGroups property </summary> <param name="autoScalingGroups">The values to add to the AutoScalingGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult.WithAutoScalingGroups(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.AutoScalingGroup})"> <summary> Sets the AutoScalingGroups property </summary> <param name="autoScalingGroups">The values to add to the AutoScalingGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult.AutoScalingGroups"> <summary> Gets and sets the property AutoScalingGroups. <para> A list of Auto Scaling groups. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest"> <summary> Container for the parameters to the DescribeAutoScalingInstances operation. Returns a description of each Auto Scaling instance in the <code>InstanceIds</code> list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items. <para> This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the <code>NextToken</code> parameter. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.WithInstanceIds(System.String[])"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.WithInstanceIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of Auto Scaling instances to be described with each call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token returned by a previous call to indicate that there is more data available. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResponse"> <summary> Returns information about the DescribeAutoScalingInstancesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResponse.DescribeAutoScalingInstancesResult"> <summary> Gets and sets the DescribeAutoScalingInstancesResult property. Represents the output of a DescribeAutoScalingInstances operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult"> <summary> The <code>AutoScalingInstancesType</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult.WithAutoScalingInstances(Amazon.AutoScaling.Model.AutoScalingInstanceDetails[])"> <summary> Sets the AutoScalingInstances property </summary> <param name="autoScalingInstances">The values to add to the AutoScalingInstances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult.WithAutoScalingInstances(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.AutoScalingInstanceDetails})"> <summary> Sets the AutoScalingInstances property </summary> <param name="autoScalingInstances">The values to add to the AutoScalingInstances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult.AutoScalingInstances"> <summary> Gets and sets the property AutoScalingInstances. <para> A list of Auto Scaling instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest"> <summary> Container for the parameters to the DescribeAutoScalingNotificationTypes operation. Returns a list of all notification types that are supported by Auto Scaling. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResponse"> <summary> Returns information about the DescribeAutoScalingNotificationTypesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResponse.DescribeAutoScalingNotificationTypesResult"> <summary> Gets and sets the DescribeAutoScalingNotificationTypesResult property. Represents the output of a DescribeAutoScalingNotificationTypes operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResult"> <summary> The <code>AutoScalingNotificationTypes</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResult.WithAutoScalingNotificationTypes(System.String[])"> <summary> Sets the AutoScalingNotificationTypes property </summary> <param name="autoScalingNotificationTypes">The values to add to the AutoScalingNotificationTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResult.WithAutoScalingNotificationTypes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the AutoScalingNotificationTypes property </summary> <param name="autoScalingNotificationTypes">The values to add to the AutoScalingNotificationTypes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResult.AutoScalingNotificationTypes"> <summary> Gets and sets the property AutoScalingNotificationTypes. <para> Returns a list of all notification types supported by Auto Scaling. They are: </para> <ul> <li> <para> <code>autoscaling:EC2_INSTANCE_LAUNCH</code> </para> </li> <li> <para> <code>autoscaling:EC2_INSTANCE_LAUNCH_ERROR</code> </para> </li> <li> <para> <code>autoscaling:EC2_INSTANCE_TERMINATE</code> </para> </li> <li> <para> <code>autoscaling:EC2_INSTANCE_TERMINATE_ERROR</code> </para> </li> <li> <para> <code>autoscaling:TEST_NOTIFICATION</code> </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest"> <summary> Container for the parameters to the DescribeLaunchConfigurations operation. Returns a full description of the launch configurations, or the specified launch configurations, if they exist. <para> If no name is specified, then the full details of all launch configurations are returned. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.WithLaunchConfigurationNames(System.String[])"> <summary> Sets the LaunchConfigurationNames property </summary> <param name="launchConfigurationNames">The values to add to the LaunchConfigurationNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.WithLaunchConfigurationNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the LaunchConfigurationNames property </summary> <param name="launchConfigurationNames">The values to add to the LaunchConfigurationNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.LaunchConfigurationNames"> <summary> Gets and sets the property LaunchConfigurationNames. <para> A list of launch configuration names. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of launch configurations. The default is 100. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResponse"> <summary> Returns information about the DescribeLaunchConfigurationsResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResponse.DescribeLaunchConfigurationsResult"> <summary> Gets and sets the DescribeLaunchConfigurationsResult property. Represents the output of a DescribeLaunchConfigurations operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult"> <summary> The <code>LaunchConfigurationsType</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult.WithLaunchConfigurations(Amazon.AutoScaling.Model.LaunchConfiguration[])"> <summary> Sets the LaunchConfigurations property </summary> <param name="launchConfigurations">The values to add to the LaunchConfigurations collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult.WithLaunchConfigurations(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.LaunchConfiguration})"> <summary> Sets the LaunchConfigurations property </summary> <param name="launchConfigurations">The values to add to the LaunchConfigurations collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult.LaunchConfigurations"> <summary> Gets and sets the property LaunchConfigurations. <para> A list of launch configurations. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest"> <summary> Container for the parameters to the DescribeLifecycleHooks operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest.WithLifecycleHookNames(System.String[])"> <summary> Sets the LifecycleHookNames property </summary> <param name="lifecycleHookNames">The values to add to the LifecycleHookNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest.WithLifecycleHookNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the LifecycleHookNames property </summary> <param name="lifecycleHookNames">The values to add to the LifecycleHookNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest.LifecycleHookNames"> <summary> Gets and sets the property LifecycleHookNames. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHooksResponse"> <summary> Returns information about the DescribeLifecycleHooksResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHooksResponse.DescribeLifecycleHooksResult"> <summary> Gets and sets the DescribeLifecycleHooksResult property. Represents the output of a DescribeLifecycleHooks operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHooksResult"> <summary> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLifecycleHooksResult.WithLifecycleHooks(Amazon.AutoScaling.Model.LifecycleHook[])"> <summary> Sets the LifecycleHooks property </summary> <param name="lifecycleHooks">The values to add to the LifecycleHooks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLifecycleHooksResult.WithLifecycleHooks(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.LifecycleHook})"> <summary> Sets the LifecycleHooks property </summary> <param name="lifecycleHooks">The values to add to the LifecycleHooks collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHooksResult.LifecycleHooks"> <summary> Gets and sets the property LifecycleHooks. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest"> <summary> Container for the parameters to the DescribeLifecycleHookTypes operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResponse"> <summary> Returns information about the DescribeLifecycleHookTypesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResponse.DescribeLifecycleHookTypesResult"> <summary> Gets and sets the DescribeLifecycleHookTypesResult property. Represents the output of a DescribeLifecycleHookTypes operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResult"> <summary> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResult.WithLifecycleHookTypes(System.String[])"> <summary> Sets the LifecycleHookTypes property </summary> <param name="lifecycleHookTypes">The values to add to the LifecycleHookTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResult.WithLifecycleHookTypes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the LifecycleHookTypes property </summary> <param name="lifecycleHookTypes">The values to add to the LifecycleHookTypes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResult.LifecycleHookTypes"> <summary> Gets and sets the property LifecycleHookTypes. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest"> <summary> Container for the parameters to the DescribeMetricCollectionTypes operation. Returns a list of metrics and a corresponding list of granularities for each metric. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResponse"> <summary> Returns information about the DescribeMetricCollectionTypesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResponse.DescribeMetricCollectionTypesResult"> <summary> Gets and sets the DescribeMetricCollectionTypesResult property. Represents the output of a DescribeMetricCollectionTypes operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult"> <summary> The output of the <a>DescribeMetricCollectionTypes</a> action. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.WithGranularities(Amazon.AutoScaling.Model.MetricGranularityType[])"> <summary> Sets the Granularities property </summary> <param name="granularities">The values to add to the Granularities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.WithGranularities(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.MetricGranularityType})"> <summary> Sets the Granularities property </summary> <param name="granularities">The values to add to the Granularities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.WithMetrics(Amazon.AutoScaling.Model.MetricCollectionType[])"> <summary> Sets the Metrics property </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.WithMetrics(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.MetricCollectionType})"> <summary> Sets the Metrics property </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.Granularities"> <summary> Gets and sets the property Granularities. <para> A list of granularities for the listed Metrics. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.Metrics"> <summary> Gets and sets the property Metrics. <para> The list of Metrics collected. The following metrics are supported: </para> <ul> <li> <para> GroupMinSize </para> </li> <li> <para> GroupMaxSize </para> </li> <li> <para> GroupDesiredCapacity </para> </li> <li> <para> GroupInServiceInstances </para> </li> <li> <para> GroupPendingInstances </para> </li> <li> <para> GroupTerminatingInstances </para> </li> <li> <para> GroupTotalInstances </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest"> <summary> Container for the parameters to the DescribeNotificationConfigurations operation. Returns a list of notification actions associated with Auto Scaling groups for specified events. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.WithAutoScalingGroupNames(System.String[])"> <summary> Sets the AutoScalingGroupNames property </summary> <param name="autoScalingGroupNames">The values to add to the AutoScalingGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.WithAutoScalingGroupNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the AutoScalingGroupNames property </summary> <param name="autoScalingGroupNames">The values to add to the AutoScalingGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.AutoScalingGroupNames"> <summary> Gets and sets the property AutoScalingGroupNames. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> Maximum number of records to be returned. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that is used to mark the start of the next batch of returned results for pagination. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResponse"> <summary> Returns information about the DescribeNotificationConfigurationsResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResponse.DescribeNotificationConfigurationsResult"> <summary> Gets and sets the DescribeNotificationConfigurationsResult property. Represents the output of a DescribeNotificationConfigurations operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult"> <summary> The output of the <a>DescribeNotificationConfigurations</a> action. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult.WithNotificationConfigurations(Amazon.AutoScaling.Model.NotificationConfiguration[])"> <summary> Sets the NotificationConfigurations property </summary> <param name="notificationConfigurations">The values to add to the NotificationConfigurations collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult.WithNotificationConfigurations(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.NotificationConfiguration})"> <summary> Sets the NotificationConfigurations property </summary> <param name="notificationConfigurations">The values to add to the NotificationConfigurations collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that is used to mark the start of the next batch of returned results for pagination. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult.NotificationConfigurations"> <summary> Gets and sets the property NotificationConfigurations. <para> The list of notification configurations. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribePoliciesRequest"> <summary> Container for the parameters to the DescribePolicies operation. Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesRequest.WithPolicyNames(System.String[])"> <summary> Sets the PolicyNames property </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesRequest.WithPolicyNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the PolicyNames property </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of policies that will be described with each call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that is used to mark the start of the next batch of returned results for pagination. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.PolicyNames"> <summary> Gets and sets the property PolicyNames. <para> A list of policy names or policy ARNs to be described. If this list is omitted, all policy names are described. If an auto scaling group name is provided, the results are limited to that group. The list of requested policy names cannot contain more than 50 items. If unknown policy names are requested, they are ignored with no error. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribePoliciesResponse"> <summary> Returns information about the DescribePoliciesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesResponse.DescribePoliciesResult"> <summary> Gets and sets the DescribePoliciesResult property. Represents the output of a DescribePolicies operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribePoliciesResult"> <summary> The <code>PoliciesType</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesResult.WithScalingPolicies(Amazon.AutoScaling.Model.ScalingPolicy[])"> <summary> Sets the ScalingPolicies property </summary> <param name="scalingPolicies">The values to add to the ScalingPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribePoliciesResult.WithScalingPolicies(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.ScalingPolicy})"> <summary> Sets the ScalingPolicies property </summary> <param name="scalingPolicies">The values to add to the ScalingPolicies collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesResult.ScalingPolicies"> <summary> Gets and sets the property ScalingPolicies. <para> A list of scaling policies. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest"> <summary> Container for the parameters to the DescribeScalingActivities operation. Returns the scaling activities for the specified Auto Scaling group. <para> If the specified <code>ActivityIds</code> list is empty, all the activities from the past six weeks are returned. Activities are sorted by the start time. Activities still in progress appear first on the list. </para> <para> This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the <code>NextToken</code> parameter. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.WithActivityIds(System.String[])"> <summary> Sets the ActivityIds property </summary> <param name="activityIds">The values to add to the ActivityIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.WithActivityIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ActivityIds property </summary> <param name="activityIds">The values to add to the ActivityIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.ActivityIds"> <summary> Gets and sets the property ActivityIds. <para> A list containing the activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If an <code>AutoScalingGroupName</code> is provided, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the <a>AutoScalingGroup</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of scaling activities to return. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results for pagination. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingActivitiesResponse"> <summary> Returns information about the DescribeScalingActivitiesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesResponse.DescribeScalingActivitiesResult"> <summary> Gets and sets the DescribeScalingActivitiesResult property. Represents the output of a DescribeScalingActivities operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult"> <summary> The output for the <a>DescribeScalingActivities</a> action. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult.WithActivities(Amazon.AutoScaling.Model.Activity[])"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult.WithActivities(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Activity})"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult.Activities"> <summary> Gets and sets the property Activities. <para> A list of the requested scaling activities. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> Acts as a paging mechanism for large result sets. Set to a non-empty string if there are additional results waiting to be returned. Pass this in to subsequent calls to return additional results. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest"> <summary> Container for the parameters to the DescribeScalingProcessTypes operation. Returns scaling process types for use in the <a>ResumeProcesses</a> and <a>SuspendProcesses</a> actions. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResponse"> <summary> Returns information about the DescribeScalingProcessTypesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResponse.DescribeScalingProcessTypesResult"> <summary> Gets and sets the DescribeScalingProcessTypesResult property. Represents the output of a DescribeScalingProcessTypes operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResult"> <summary> The output of the <a>DescribeScalingProcessTypes</a> action. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResult.WithProcesses(Amazon.AutoScaling.Model.ProcessType[])"> <summary> Sets the Processes property </summary> <param name="processes">The values to add to the Processes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResult.WithProcesses(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.ProcessType})"> <summary> Sets the Processes property </summary> <param name="processes">The values to add to the Processes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResult.Processes"> <summary> Gets and sets the property Processes. <para> A list of <a>ProcessType</a> names. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest"> <summary> Container for the parameters to the DescribeScheduledActions operation. Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of actions already executed, see the activity record returned in <a>DescribeScalingActivities</a>. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.WithEndTime(System.DateTime)"> <summary> Sets the EndTime property </summary> <param name="endTime">The value to set for the EndTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.WithScheduledActionNames(System.String[])"> <summary> Sets the ScheduledActionNames property </summary> <param name="scheduledActionNames">The values to add to the ScheduledActionNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.WithScheduledActionNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ScheduledActionNames property </summary> <param name="scheduledActionNames">The values to add to the ScheduledActionNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> The latest scheduled start time to return. If scheduled action names are provided, this field is ignored. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of scheduled actions to return. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.ScheduledActionNames"> <summary> Gets and sets the property ScheduledActionNames. <para> A list of scheduled actions to be described. If this list is omitted, all scheduled actions are described. The list of requested scheduled actions cannot contain more than 50 items. If an auto scaling group name is provided, the results are limited to that group. If unknown scheduled actions are requested, they are ignored with no error. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> The earliest scheduled start time to return. If scheduled action names are provided, this field will be ignored. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScheduledActionsResponse"> <summary> Returns information about the DescribeScheduledActionsResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsResponse.DescribeScheduledActionsResult"> <summary> Gets and sets the DescribeScheduledActionsResult property. Represents the output of a DescribeScheduledActions operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScheduledActionsResult"> <summary> A scaling action that is scheduled for a future time and date. An action can be scheduled up to thirty days in advance. <para> Starting with API version 2011-01-01, you can use <code>recurrence</code> to specify that a scaling action occurs regularly on a schedule. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsResult.WithScheduledUpdateGroupActions(Amazon.AutoScaling.Model.ScheduledUpdateGroupAction[])"> <summary> Sets the ScheduledUpdateGroupActions property </summary> <param name="scheduledUpdateGroupActions">The values to add to the ScheduledUpdateGroupActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeScheduledActionsResult.WithScheduledUpdateGroupActions(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.ScheduledUpdateGroupAction})"> <summary> Sets the ScheduledUpdateGroupActions property </summary> <param name="scheduledUpdateGroupActions">The values to add to the ScheduledUpdateGroupActions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsResult.ScheduledUpdateGroupActions"> <summary> Gets and sets the property ScheduledUpdateGroupActions. <para> A list of scheduled actions designed to update an Auto Scaling group. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTagsRequest"> <summary> Container for the parameters to the DescribeTags operation. Lists the Auto Scaling group tags. <para> You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your filters. If there's no match, no special message is returned. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTagsRequest.WithFilters(Amazon.AutoScaling.Model.Filter[])"> <summary> Sets the Filters property </summary> <param name="filters">The values to add to the Filters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTagsRequest.WithFilters(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Filter})"> <summary> Sets the Filters property </summary> <param name="filters">The values to add to the Filters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTagsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTagsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsRequest.Filters"> <summary> Gets and sets the property Filters. <para> The value of the filter type used to identify the tags to be returned. For example, you can filter so that tags are returned according to Auto Scaling group, the key and value, or whether the new tag will be applied to instances launched after the tag is created (PropagateAtLaunch). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of records to return. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that marks the start of the next batch of returned results. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTagsResponse"> <summary> Returns information about the DescribeTagsResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsResponse.DescribeTagsResult"> <summary> Gets and sets the DescribeTagsResult property. Represents the output of a DescribeTags operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTagsResult"> <summary> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTagsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTagsResult.WithTags(Amazon.AutoScaling.Model.TagDescription[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTagsResult.WithTags(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.TagDescription})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A string used to mark the start of the next batch of returned results. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsResult.Tags"> <summary> Gets and sets the property Tags. <para> The list of tags. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest"> <summary> Container for the parameters to the DescribeTerminationPolicyTypes operation. Returns a list of all termination policies supported by Auto Scaling. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResponse"> <summary> Returns information about the DescribeTerminationPolicyTypesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResponse.DescribeTerminationPolicyTypesResult"> <summary> Gets and sets the DescribeTerminationPolicyTypesResult property. Represents the output of a DescribeTerminationPolicyTypes operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResult"> <summary> The <code>TerminationPolicyTypes</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResult.WithTerminationPolicyTypes(System.String[])"> <summary> Sets the TerminationPolicyTypes property </summary> <param name="terminationPolicyTypes">The values to add to the TerminationPolicyTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResult.WithTerminationPolicyTypes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the TerminationPolicyTypes property </summary> <param name="terminationPolicyTypes">The values to add to the TerminationPolicyTypes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResult.TerminationPolicyTypes"> <summary> Gets and sets the property TerminationPolicyTypes. <para> Termination policies supported by Auto Scaling. They are: <code>OldestInstance</code>, <code>OldestLaunchConfiguration</code>, <code>NewestInstance</code>, <code>ClosestToNextInstanceHour</code>, <code>Default</code> </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DetachInstancesRequest"> <summary> Container for the parameters to the DetachInstances operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DetachInstancesRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DetachInstancesRequest.WithInstanceIds(System.String[])"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DetachInstancesRequest.WithInstanceIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DetachInstancesRequest.WithShouldDecrementDesiredCapacity(System.Boolean)"> <summary> Sets the ShouldDecrementDesiredCapacity property </summary> <param name="shouldDecrementDesiredCapacity">The value to set for the ShouldDecrementDesiredCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesRequest.ShouldDecrementDesiredCapacity"> <summary> Gets and sets the property ShouldDecrementDesiredCapacity. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DetachInstancesResponse"> <summary> Returns information about the DetachInstancesResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesResponse.DetachInstancesResult"> <summary> Gets and sets the DetachInstancesResult property. Represents the output of a DetachInstances operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DetachInstancesResult"> <summary> </summary> </member> <member name="M:Amazon.AutoScaling.Model.DetachInstancesResult.WithActivities(Amazon.AutoScaling.Model.Activity[])"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DetachInstancesResult.WithActivities(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Activity})"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesResult.Activities"> <summary> Gets and sets the property Activities. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest"> <summary> Container for the parameters to the DisableMetricsCollection operation. Disables monitoring of group metrics for the Auto Scaling group specified in <code>AutoScalingGroupName</code>. You can specify the list of affected metrics with the <code>Metrics</code> parameter. </summary> </member> <member name="M:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest.WithMetrics(System.String[])"> <summary> Sets the Metrics property </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest.WithMetrics(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Metrics property </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or ARN of the Auto Scaling Group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest.Metrics"> <summary> Gets and sets the property Metrics. <para> The list of metrics to disable. If no metrics are specified, all metrics are disabled. The following metrics are supported: </para> <ul> <li> <para> GroupMinSize </para> </li> <li> <para> GroupMaxSize </para> </li> <li> <para> GroupDesiredCapacity </para> </li> <li> <para> GroupInServiceInstances </para> </li> <li> <para> GroupPendingInstances </para> </li> <li> <para> GroupTerminatingInstances </para> </li> <li> <para> GroupTotalInstances </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DisableMetricsCollectionResponse"> <summary> Returns information about the DisableMetricsCollectionResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.Ebs"> <summary> The Ebs data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.Ebs.WithDeleteOnTermination(System.Boolean)"> <summary> Sets the DeleteOnTermination property </summary> <param name="deleteOnTermination">The value to set for the DeleteOnTermination property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Ebs.WithIops(System.Int32)"> <summary> Sets the Iops property </summary> <param name="iops">The value to set for the Iops property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Ebs.WithSnapshotId(System.String)"> <summary> Sets the SnapshotId property </summary> <param name="snapshotId">The value to set for the SnapshotId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Ebs.WithVolumeSize(System.Int32)"> <summary> Sets the VolumeSize property </summary> <param name="volumeSize">The value to set for the VolumeSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Ebs.WithVolumeType(System.String)"> <summary> Sets the VolumeType property </summary> <param name="volumeType">The value to set for the VolumeType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether to delete the volume on instance termination. </para> <para> Default: <code>true</code> </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.Iops"> <summary> Gets and sets the property Iops. <para> The number of I/O operations per second (IOPS) that the volume supports. </para> <para> The maximum ratio of IOPS to volume size is 30.0 </para> <para> Valid Values: Range is 100 to 4000. </para> <para> Default: None. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The snapshot ID. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.VolumeSize"> <summary> Gets and sets the property VolumeSize. <para> The volume size, in gigabytes. </para> <para> Valid values: If the volume type is <code>io1</code>, the minimum size of the volume is 10. </para> <para> Default: If you're creating the volume from a snapshot, and you don't specify a volume size, the default is the snapshot size. </para> <para> Required: Required when the volume type is <code>io1</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.VolumeType"> <summary> Gets and sets the property VolumeType. <para> The volume type. </para> <para> Valid values: <code>standard | io1</code> </para> <para> Default: <code>standard</code> </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnabledMetric"> <summary> The <code>EnabledMetric</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.EnabledMetric.WithGranularity(System.String)"> <summary> Sets the Granularity property </summary> <param name="granularity">The value to set for the Granularity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnabledMetric.WithMetric(System.String)"> <summary> Sets the Metric property </summary> <param name="metric">The value to set for the Metric property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.EnabledMetric.Granularity"> <summary> Gets and sets the property Granularity. <para> The granularity of the enabled metric. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnabledMetric.Metric"> <summary> Gets and sets the property Metric. <para> The name of the enabled metric. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest"> <summary> Container for the parameters to the EnableMetricsCollection operation. Enables monitoring of group metrics for the Auto Scaling group specified in <code>AutoScalingGroupName</code>. You can specify the list of enabled metrics with the <code>Metrics</code> parameter. <para> Auto Scaling metrics collection can be turned on only if the <code>InstanceMonitoring</code> flag, in the Auto Scaling group's launch configuration, is set to <code>True</code>. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.WithGranularity(System.String)"> <summary> Sets the Granularity property </summary> <param name="granularity">The value to set for the Granularity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.WithMetrics(System.String[])"> <summary> Sets the Metrics property </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.WithMetrics(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Metrics property </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or ARN of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.Granularity"> <summary> Gets and sets the property Granularity. <para> The granularity to associate with the metrics to collect. Currently, the only legal granularity is "1Minute". </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.Metrics"> <summary> Gets and sets the property Metrics. <para> The list of metrics to collect. If no metrics are specified, all metrics are enabled. The following metrics are supported: </para> <ul> <li> <para> GroupMinSize </para> </li> <li> <para> GroupMaxSize </para> </li> <li> <para> GroupDesiredCapacity </para> </li> <li> <para> GroupInServiceInstances </para> </li> <li> <para> GroupPendingInstances </para> </li> <li> <para> GroupTerminatingInstances </para> </li> <li> <para> GroupTotalInstances </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnableMetricsCollectionResponse"> <summary> Returns information about the EnableMetricsCollectionResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnterStandbyRequest"> <summary> Container for the parameters to the EnterStandby operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.EnterStandbyRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnterStandbyRequest.WithInstanceIds(System.String[])"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnterStandbyRequest.WithInstanceIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnterStandbyRequest.WithShouldDecrementDesiredCapacity(System.Boolean)"> <summary> Sets the ShouldDecrementDesiredCapacity property </summary> <param name="shouldDecrementDesiredCapacity">The value to set for the ShouldDecrementDesiredCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyRequest.ShouldDecrementDesiredCapacity"> <summary> Gets and sets the property ShouldDecrementDesiredCapacity. </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnterStandbyResponse"> <summary> Returns information about the EnterStandbyResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyResponse.EnterStandbyResult"> <summary> Gets and sets the EnterStandbyResult property. Represents the output of a EnterStandby operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnterStandbyResult"> <summary> </summary> </member> <member name="M:Amazon.AutoScaling.Model.EnterStandbyResult.WithActivities(Amazon.AutoScaling.Model.Activity[])"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.EnterStandbyResult.WithActivities(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Activity})"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyResult.Activities"> <summary> Gets and sets the property Activities. </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExecutePolicyRequest"> <summary> Container for the parameters to the ExecutePolicy operation. Executes the specified policy. </summary> </member> <member name="M:Amazon.AutoScaling.Model.ExecutePolicyRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ExecutePolicyRequest.WithHonorCooldown(System.Boolean)"> <summary> Sets the HonorCooldown property </summary> <param name="honorCooldown">The value to set for the HonorCooldown property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ExecutePolicyRequest.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.ExecutePolicyRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or the Amazon Resource Name (ARN) of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExecutePolicyRequest.HonorCooldown"> <summary> Gets and sets the property HonorCooldown. <para> Set to <code>True</code> if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before executing the policy. </para> <para> Set to <code>False</code> if you want Auto Scaling to circumvent the cooldown period associated with the Auto Scaling group and execute the policy before the cooldown period ends. </para> <para> For information about cooldown period, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AS_Concepts.html#Cooldown">Cooldown Period</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExecutePolicyRequest.PolicyName"> <summary> Gets and sets the property PolicyName. <para> The name or ARN of the policy you want to run. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExecutePolicyResponse"> <summary> Returns information about the ExecutePolicyResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExitStandbyRequest"> <summary> Container for the parameters to the ExitStandby operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.ExitStandbyRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ExitStandbyRequest.WithInstanceIds(System.String[])"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ExitStandbyRequest.WithInstanceIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the InstanceIds property </summary> <param name="instanceIds">The values to add to the InstanceIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.ExitStandbyRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExitStandbyRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExitStandbyResponse"> <summary> Returns information about the ExitStandbyResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExitStandbyResponse.ExitStandbyResult"> <summary> Gets and sets the ExitStandbyResult property. Represents the output of a ExitStandby operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExitStandbyResult"> <summary> </summary> </member> <member name="M:Amazon.AutoScaling.Model.ExitStandbyResult.WithActivities(Amazon.AutoScaling.Model.Activity[])"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ExitStandbyResult.WithActivities(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Activity})"> <summary> Sets the Activities property </summary> <param name="activities">The values to add to the Activities collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.ExitStandbyResult.Activities"> <summary> Gets and sets the property Activities. </summary> </member> <member name="T:Amazon.AutoScaling.Model.Filter"> <summary> The <code>Filter</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.Filter.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Filter.WithValues(System.String[])"> <summary> Sets the Values property </summary> <param name="values">The values to add to the Values collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Filter.WithValues(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Values property </summary> <param name="values">The values to add to the Values collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.Filter.Name"> <summary> Gets and sets the property Name. <para> The name of the filter. Valid Name values are: <code>"auto-scaling-group"</code>, <code>"key"</code>, <code>"value"</code>, and <code>"propagate-at-launch"</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Filter.Values"> <summary> Gets and sets the property Values. <para> The value of the filter. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.Instance"> <summary> The <code>Instance</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.Instance.WithAvailabilityZone(System.String)"> <summary> Sets the AvailabilityZone property </summary> <param name="availabilityZone">The value to set for the AvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Instance.WithHealthStatus(System.String)"> <summary> Sets the HealthStatus property </summary> <param name="healthStatus">The value to set for the HealthStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Instance.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Instance.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Instance.WithLifecycleState(System.String)"> <summary> Sets the LifecycleState property </summary> <param name="lifecycleState">The value to set for the LifecycleState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.Instance.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> Availability Zones associated with this instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.HealthStatus"> <summary> Gets and sets the property HealthStatus. <para> The instance's health status. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.InstanceId"> <summary> Gets and sets the property InstanceId. <para> Specifies the ID of the Amazon EC2 instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> The launch configuration associated with this instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.LifecycleState"> <summary> Gets and sets the property LifecycleState. <para> Contains a description of the current <i>lifecycle</i> state. </para> <note> <para> The <code>Quarantined</code> lifecycle state is currently not used. </para> </note> </summary> </member> <member name="T:Amazon.AutoScaling.Model.InstanceMonitoring"> <summary> The <code>InstanceMonitoring</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.InstanceMonitoring.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.InstanceMonitoring.Enabled"> <summary> Gets and sets the property Enabled. <para> If <code>True</code>, instance monitoring is enabled. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ActivityUnmarshaller"> <summary> Response Unmarshaller for Activity Object </summary> </member> <member name="T:Amazon.Runtime.Internal.Transform.IUnmarshaller`2"> <summary> Interface for unmarshallers which unmarshall objects from response data. The Unmarshallers are stateless, and only encode the rules for what data in the XML stream goes into what members of an object. </summary> <typeparam name="T">The type of object the unmarshaller returns</typeparam> <typeparam name="R">The type of the XML unmashaller context, which contains the state during parsing of the XML stream. Usually an instance of <c>Amazon.Runtime.Internal.Transform.UnmarshallerContext</c>.</typeparam> </member> <member name="M:Amazon.Runtime.Internal.Transform.IUnmarshaller`2.Unmarshall(`1)"> <summary> Given the current position in the XML stream, extract a T. </summary> <param name="input">The XML parsing context</param> <returns>An object of type T populated with data from the XML stream.</returns> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.AdjustmentTypeUnmarshaller"> <summary> Response Unmarshaller for AdjustmentType Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.AlarmUnmarshaller"> <summary> Response Unmarshaller for Alarm Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.AttachInstancesRequestMarshaller"> <summary> AttachInstances Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.AttachInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for AttachInstances operation </summary> </member> <member name="T:Amazon.Runtime.Internal.Transform.XmlResponseUnmarshaller"> <summary> Class for unmarshalling XML service responses. </summary> </member> <member name="T:Amazon.Runtime.Internal.Transform.ResponseUnmarshaller"> <summary> Abstract class for unmarshalling service responses. </summary> </member> <member name="T:Amazon.Runtime.Internal.Transform.IResponseUnmarshaller`2"> <summary> Interface for unmarshallers which unmarshall service responses. The Unmarshallers are stateless, and only encode the rules for what data in the XML stream goes into what members of an object. </summary> <typeparam name="T">The type of object the unmarshaller returns</typeparam> <typeparam name="R">The type of the XML unmashaller context, which contains the state of parsing the XML stream. Uaually an instance of <c>Amazon.Runtime.Internal.Transform.UnmarshallerContext</c>.</typeparam> </member> <member name="M:Amazon.Runtime.Internal.Transform.IResponseUnmarshaller`2.UnmarshallException(`1,System.Exception,System.Net.HttpStatusCode)"> <summary> Extracts an exeption with data from an ErrorResponse. </summary> <param name="input">The XML parsing context.</param> <param name="innerException">An inner exception to be included with the returned exception</param> <param name="statusCode">The HttpStatusCode from the ErrorResponse</param> <returns>Either an exception based on the ErrorCode from the ErrorResponse, or the general service exception for the service in question.</returns> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.AutoScalingGroupUnmarshaller"> <summary> Response Unmarshaller for AutoScalingGroup Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.AutoScalingInstanceDetailsUnmarshaller"> <summary> Response Unmarshaller for AutoScalingInstanceDetails Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.BlockDeviceMappingUnmarshaller"> <summary> Response Unmarshaller for BlockDeviceMapping Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CompleteLifecycleActionRequestMarshaller"> <summary> CompleteLifecycleAction Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CompleteLifecycleActionResponseUnmarshaller"> <summary> Response Unmarshaller for CompleteLifecycleAction operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CompleteLifecycleActionResultUnmarshaller"> <summary> Response Unmarshaller for CompleteLifecycleAction Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CreateAutoScalingGroupRequestMarshaller"> <summary> CreateAutoScalingGroup Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CreateAutoScalingGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateAutoScalingGroup operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CreateLaunchConfigurationRequestMarshaller"> <summary> CreateLaunchConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CreateLaunchConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLaunchConfiguration operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CreateOrUpdateTagsRequestMarshaller"> <summary> CreateOrUpdateTags Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.CreateOrUpdateTagsResponseUnmarshaller"> <summary> Response Unmarshaller for CreateOrUpdateTags operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteAutoScalingGroupRequestMarshaller"> <summary> DeleteAutoScalingGroup Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteAutoScalingGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteAutoScalingGroup operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteLaunchConfigurationRequestMarshaller"> <summary> DeleteLaunchConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteLaunchConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLaunchConfiguration operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteLifecycleHookRequestMarshaller"> <summary> DeleteLifecycleHook Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteLifecycleHookResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLifecycleHook operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteLifecycleHookResultUnmarshaller"> <summary> Response Unmarshaller for DeleteLifecycleHook Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteNotificationConfigurationRequestMarshaller"> <summary> DeleteNotificationConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteNotificationConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteNotificationConfiguration operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeletePolicyRequestMarshaller"> <summary> DeletePolicy Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeletePolicyResponseUnmarshaller"> <summary> Response Unmarshaller for DeletePolicy operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteScheduledActionRequestMarshaller"> <summary> DeleteScheduledAction Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteScheduledActionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteScheduledAction operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteTagsRequestMarshaller"> <summary> DeleteTags Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DeleteTagsResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteTags operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAccountLimitsRequestMarshaller"> <summary> DescribeAccountLimits Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAccountLimitsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAccountLimits operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAccountLimitsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeAccountLimits Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAdjustmentTypesRequestMarshaller"> <summary> DescribeAdjustmentTypes Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAdjustmentTypesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAdjustmentTypes operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAdjustmentTypesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeAdjustmentTypes Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingGroupsRequestMarshaller"> <summary> DescribeAutoScalingGroups Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAutoScalingGroups operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingGroupsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeAutoScalingGroups Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingInstancesRequestMarshaller"> <summary> DescribeAutoScalingInstances Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAutoScalingInstances operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingInstancesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeAutoScalingInstances Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingNotificationTypesRequestMarshaller"> <summary> DescribeAutoScalingNotificationTypes Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingNotificationTypesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAutoScalingNotificationTypes operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeAutoScalingNotificationTypesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeAutoScalingNotificationTypes Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLaunchConfigurationsRequestMarshaller"> <summary> DescribeLaunchConfigurations Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLaunchConfigurationsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLaunchConfigurations operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLaunchConfigurationsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeLaunchConfigurations Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLifecycleHooksRequestMarshaller"> <summary> DescribeLifecycleHooks Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLifecycleHooksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLifecycleHooks operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLifecycleHooksResultUnmarshaller"> <summary> Response Unmarshaller for DescribeLifecycleHooks Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLifecycleHookTypesRequestMarshaller"> <summary> DescribeLifecycleHookTypes Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLifecycleHookTypesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLifecycleHookTypes operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLifecycleHookTypesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeLifecycleHookTypes Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeMetricCollectionTypesRequestMarshaller"> <summary> DescribeMetricCollectionTypes Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeMetricCollectionTypesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeMetricCollectionTypes operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeMetricCollectionTypesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeMetricCollectionTypes Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeNotificationConfigurationsRequestMarshaller"> <summary> DescribeNotificationConfigurations Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeNotificationConfigurationsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeNotificationConfigurations operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeNotificationConfigurationsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeNotificationConfigurations Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribePoliciesRequestMarshaller"> <summary> DescribePolicies Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribePoliciesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribePolicies operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribePoliciesResultUnmarshaller"> <summary> Response Unmarshaller for DescribePolicies Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScalingActivitiesRequestMarshaller"> <summary> DescribeScalingActivities Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScalingActivitiesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeScalingActivities operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScalingActivitiesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeScalingActivities Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScalingProcessTypesRequestMarshaller"> <summary> DescribeScalingProcessTypes Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScalingProcessTypesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeScalingProcessTypes operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScalingProcessTypesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeScalingProcessTypes Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScheduledActionsRequestMarshaller"> <summary> DescribeScheduledActions Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScheduledActionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeScheduledActions operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeScheduledActionsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeScheduledActions Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeTagsRequestMarshaller"> <summary> DescribeTags Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeTagsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTags operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeTagsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeTags Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeTerminationPolicyTypesRequestMarshaller"> <summary> DescribeTerminationPolicyTypes Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeTerminationPolicyTypesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTerminationPolicyTypes operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeTerminationPolicyTypesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeTerminationPolicyTypes Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DetachInstancesRequestMarshaller"> <summary> DetachInstances Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DetachInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for DetachInstances operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DetachInstancesResultUnmarshaller"> <summary> Response Unmarshaller for DetachInstances Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DisableMetricsCollectionRequestMarshaller"> <summary> DisableMetricsCollection Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DisableMetricsCollectionResponseUnmarshaller"> <summary> Response Unmarshaller for DisableMetricsCollection operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.EbsUnmarshaller"> <summary> Response Unmarshaller for Ebs Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.EnabledMetricUnmarshaller"> <summary> Response Unmarshaller for EnabledMetric Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.EnableMetricsCollectionRequestMarshaller"> <summary> EnableMetricsCollection Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.EnableMetricsCollectionResponseUnmarshaller"> <summary> Response Unmarshaller for EnableMetricsCollection operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.EnterStandbyRequestMarshaller"> <summary> EnterStandby Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.EnterStandbyResponseUnmarshaller"> <summary> Response Unmarshaller for EnterStandby operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.EnterStandbyResultUnmarshaller"> <summary> Response Unmarshaller for EnterStandby Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ExecutePolicyRequestMarshaller"> <summary> ExecutePolicy Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ExecutePolicyResponseUnmarshaller"> <summary> Response Unmarshaller for ExecutePolicy operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ExitStandbyRequestMarshaller"> <summary> ExitStandby Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ExitStandbyResponseUnmarshaller"> <summary> Response Unmarshaller for ExitStandby operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ExitStandbyResultUnmarshaller"> <summary> Response Unmarshaller for ExitStandby Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.InstanceMonitoringUnmarshaller"> <summary> Response Unmarshaller for InstanceMonitoring Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.InstanceUnmarshaller"> <summary> Response Unmarshaller for Instance Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.LaunchConfigurationUnmarshaller"> <summary> Response Unmarshaller for LaunchConfiguration Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.LifecycleHookUnmarshaller"> <summary> Response Unmarshaller for LifecycleHook Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.MetricCollectionTypeUnmarshaller"> <summary> Response Unmarshaller for MetricCollectionType Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.MetricGranularityTypeUnmarshaller"> <summary> Response Unmarshaller for MetricGranularityType Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.NotificationConfigurationUnmarshaller"> <summary> Response Unmarshaller for NotificationConfiguration Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ProcessTypeUnmarshaller"> <summary> Response Unmarshaller for ProcessType Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutLifecycleHookRequestMarshaller"> <summary> PutLifecycleHook Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutLifecycleHookResponseUnmarshaller"> <summary> Response Unmarshaller for PutLifecycleHook operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutLifecycleHookResultUnmarshaller"> <summary> Response Unmarshaller for PutLifecycleHook Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutNotificationConfigurationRequestMarshaller"> <summary> PutNotificationConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutNotificationConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for PutNotificationConfiguration operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutScalingPolicyRequestMarshaller"> <summary> PutScalingPolicy Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutScalingPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for PutScalingPolicy operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutScalingPolicyResultUnmarshaller"> <summary> Response Unmarshaller for PutScalingPolicy Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutScheduledUpdateGroupActionRequestMarshaller"> <summary> PutScheduledUpdateGroupAction Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.PutScheduledUpdateGroupActionResponseUnmarshaller"> <summary> Response Unmarshaller for PutScheduledUpdateGroupAction operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.RecordLifecycleActionHeartbeatRequestMarshaller"> <summary> RecordLifecycleActionHeartbeat Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.RecordLifecycleActionHeartbeatResponseUnmarshaller"> <summary> Response Unmarshaller for RecordLifecycleActionHeartbeat operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.RecordLifecycleActionHeartbeatResultUnmarshaller"> <summary> Response Unmarshaller for RecordLifecycleActionHeartbeat Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ResumeProcessesRequestMarshaller"> <summary> ResumeProcesses Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ResumeProcessesResponseUnmarshaller"> <summary> Response Unmarshaller for ResumeProcesses operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ScalingPolicyUnmarshaller"> <summary> Response Unmarshaller for ScalingPolicy Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.ScheduledUpdateGroupActionUnmarshaller"> <summary> Response Unmarshaller for ScheduledUpdateGroupAction Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SetDesiredCapacityRequestMarshaller"> <summary> SetDesiredCapacity Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SetDesiredCapacityResponseUnmarshaller"> <summary> Response Unmarshaller for SetDesiredCapacity operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SetInstanceHealthRequestMarshaller"> <summary> SetInstanceHealth Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SetInstanceHealthResponseUnmarshaller"> <summary> Response Unmarshaller for SetInstanceHealth operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SuspendedProcessUnmarshaller"> <summary> Response Unmarshaller for SuspendedProcess Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SuspendProcessesRequestMarshaller"> <summary> SuspendProcesses Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SuspendProcessesResponseUnmarshaller"> <summary> Response Unmarshaller for SuspendProcesses operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.TagDescriptionUnmarshaller"> <summary> Response Unmarshaller for TagDescription Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.TerminateInstanceInAutoScalingGroupRequestMarshaller"> <summary> TerminateInstanceInAutoScalingGroup Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.TerminateInstanceInAutoScalingGroupResponseUnmarshaller"> <summary> Response Unmarshaller for TerminateInstanceInAutoScalingGroup operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.TerminateInstanceInAutoScalingGroupResultUnmarshaller"> <summary> Response Unmarshaller for TerminateInstanceInAutoScalingGroup Object </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.UpdateAutoScalingGroupRequestMarshaller"> <summary> UpdateAutoScalingGroup Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.UpdateAutoScalingGroupResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateAutoScalingGroup operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> <summary> AutoScaling exception </summary> </member> <member name="M:Amazon.AutoScaling.Model.InvalidNextTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidNextTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AutoScaling.Model.LaunchConfiguration"> <summary> The <code>LaunchConfiguration</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithAssociatePublicIpAddress(System.Boolean)"> <summary> Sets the AssociatePublicIpAddress property </summary> <param name="associatePublicIpAddress">The value to set for the AssociatePublicIpAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithBlockDeviceMappings(Amazon.AutoScaling.Model.BlockDeviceMapping[])"> <summary> Sets the BlockDeviceMappings property </summary> <param name="blockDeviceMappings">The values to add to the BlockDeviceMappings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithBlockDeviceMappings(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.BlockDeviceMapping})"> <summary> Sets the BlockDeviceMappings property </summary> <param name="blockDeviceMappings">The values to add to the BlockDeviceMappings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithCreatedTime(System.DateTime)"> <summary> Sets the CreatedTime property </summary> <param name="createdTime">The value to set for the CreatedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithEbsOptimized(System.Boolean)"> <summary> Sets the EbsOptimized property </summary> <param name="ebsOptimized">The value to set for the EbsOptimized property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithIamInstanceProfile(System.String)"> <summary> Sets the IamInstanceProfile property </summary> <param name="iamInstanceProfile">The value to set for the IamInstanceProfile property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithImageId(System.String)"> <summary> Sets the ImageId property </summary> <param name="imageId">The value to set for the ImageId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithInstanceMonitoring(Amazon.AutoScaling.Model.InstanceMonitoring)"> <summary> Sets the InstanceMonitoring property </summary> <param name="instanceMonitoring">The value to set for the InstanceMonitoring property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithInstanceType(System.String)"> <summary> Sets the InstanceType property </summary> <param name="instanceType">The value to set for the InstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithKernelId(System.String)"> <summary> Sets the KernelId property </summary> <param name="kernelId">The value to set for the KernelId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithKeyName(System.String)"> <summary> Sets the KeyName property </summary> <param name="keyName">The value to set for the KeyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithLaunchConfigurationARN(System.String)"> <summary> Sets the LaunchConfigurationARN property </summary> <param name="launchConfigurationARN">The value to set for the LaunchConfigurationARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithPlacementTenancy(System.String)"> <summary> Sets the PlacementTenancy property </summary> <param name="placementTenancy">The value to set for the PlacementTenancy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithRamdiskId(System.String)"> <summary> Sets the RamdiskId property </summary> <param name="ramdiskId">The value to set for the RamdiskId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithSecurityGroups(System.String[])"> <summary> Sets the SecurityGroups property </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithSecurityGroups(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the SecurityGroups property </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithSpotPrice(System.String)"> <summary> Sets the SpotPrice property </summary> <param name="spotPrice">The value to set for the SpotPrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LaunchConfiguration.WithUserData(System.String)"> <summary> Sets the UserData property </summary> <param name="userData">The value to set for the UserData property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.AssociatePublicIpAddress"> <summary> Gets and sets the property AssociatePublicIpAddress. <para> Specifies whether the instance is associated with a public IP address (<code>true</code>) or not (<code>false</code>). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> Specifies how block devices are exposed to the instance. Each mapping is made up of a <i>virtualName</i> and a <i>deviceName</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.CreatedTime"> <summary> Gets and sets the property CreatedTime. <para> Provides the creation date and time for this launch configuration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Specifies whether the instance is optimized for EBS I/O (<i>true</i>) or not (<i>false</i>). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.ImageId"> <summary> Gets and sets the property ImageId. <para> Provides the unique ID of the <i>Amazon Machine Image</i> (AMI) that was assigned during registration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.InstanceMonitoring"> <summary> Gets and sets the property InstanceMonitoring. <para> Controls whether instances in this group are launched with detailed monitoring or not. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.InstanceType"> <summary> Gets and sets the property InstanceType. <para> Specifies the instance type of the Amazon EC2 instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.KernelId"> <summary> Gets and sets the property KernelId. <para> Provides the ID of the kernel associated with the Amazon EC2 AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.KeyName"> <summary> Gets and sets the property KeyName. <para> Provides the name of the Amazon EC2 key pair. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.LaunchConfigurationARN"> <summary> Gets and sets the property LaunchConfigurationARN. <para> The launch configuration's Amazon Resource Name (ARN). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> Specifies the name of the launch configuration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.PlacementTenancy"> <summary> Gets and sets the property PlacementTenancy. <para> Specifies the tenancy of the instance. It can be either <code>default</code> or <code>dedicated</code>. An instance with <code>dedicated</code> tenancy runs in an isolated, single-tenant hardware and it can only be launched in a VPC. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> Provides ID of the RAM disk associated with the Amazon EC2 AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> A description of the security groups to associate with the Amazon EC2 instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.SpotPrice"> <summary> Gets and sets the property SpotPrice. <para> Specifies the price to bid when launching Spot Instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.UserData"> <summary> Gets and sets the property UserData. <para> The user data available to the launched Amazon EC2 instances. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.LifecycleHook"> <summary> </summary> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithDefaultResult(System.String)"> <summary> Sets the DefaultResult property </summary> <param name="defaultResult">The value to set for the DefaultResult property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithGlobalTimeout(System.Int32)"> <summary> Sets the GlobalTimeout property </summary> <param name="globalTimeout">The value to set for the GlobalTimeout property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithHeartbeatTimeout(System.Int32)"> <summary> Sets the HeartbeatTimeout property </summary> <param name="heartbeatTimeout">The value to set for the HeartbeatTimeout property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithLifecycleHookName(System.String)"> <summary> Sets the LifecycleHookName property </summary> <param name="lifecycleHookName">The value to set for the LifecycleHookName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithLifecycleTransition(System.String)"> <summary> Sets the LifecycleTransition property </summary> <param name="lifecycleTransition">The value to set for the LifecycleTransition property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithNotificationMetadata(System.String)"> <summary> Sets the NotificationMetadata property </summary> <param name="notificationMetadata">The value to set for the NotificationMetadata property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithNotificationTargetARN(System.String)"> <summary> Sets the NotificationTargetARN property </summary> <param name="notificationTargetARN">The value to set for the NotificationTargetARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.LifecycleHook.WithRoleARN(System.String)"> <summary> Sets the RoleARN property </summary> <param name="roleARN">The value to set for the RoleARN property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.DefaultResult"> <summary> Gets and sets the property DefaultResult. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.GlobalTimeout"> <summary> Gets and sets the property GlobalTimeout. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.HeartbeatTimeout"> <summary> Gets and sets the property HeartbeatTimeout. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.LifecycleTransition"> <summary> Gets and sets the property LifecycleTransition. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.NotificationMetadata"> <summary> Gets and sets the property NotificationMetadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.NotificationTargetARN"> <summary> Gets and sets the property NotificationTargetARN. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.RoleARN"> <summary> Gets and sets the property RoleARN. </summary> </member> <member name="T:Amazon.AutoScaling.Model.LimitExceededException"> <summary> AutoScaling exception </summary> </member> <member name="M:Amazon.AutoScaling.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AutoScaling.Model.MetricCollectionType"> <summary> The MetricCollectionType data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.MetricCollectionType.WithMetric(System.String)"> <summary> Sets the Metric property </summary> <param name="metric">The value to set for the Metric property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.MetricCollectionType.Metric"> <summary> Gets and sets the property Metric. </summary> </member> <member name="T:Amazon.AutoScaling.Model.MetricGranularityType"> <summary> The MetricGranularityType data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.MetricGranularityType.WithGranularity(System.String)"> <summary> Sets the Granularity property </summary> <param name="granularity">The value to set for the Granularity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.MetricGranularityType.Granularity"> <summary> Gets and sets the property Granularity. <para> The granularity of a Metric. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.NotificationConfiguration"> <summary> The <code>NotificationConfiguration</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.NotificationConfiguration.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.NotificationConfiguration.WithNotificationType(System.String)"> <summary> Sets the NotificationType property </summary> <param name="notificationType">The value to set for the NotificationType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.NotificationConfiguration.WithTopicARN(System.String)"> <summary> Sets the TopicARN property </summary> <param name="topicARN">The value to set for the TopicARN property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.NotificationConfiguration.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> Specifies the Auto Scaling group name. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.NotificationConfiguration.NotificationType"> <summary> Gets and sets the property NotificationType. <para> The types of events for an action to start. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.NotificationConfiguration.TopicARN"> <summary> Gets and sets the property TopicARN. <para> The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ProcessType"> <summary> There are two primary Auto Scaling process types--<code>Launch</code> and <code>Terminate</code>. The <code>Launch</code> process creates a new Amazon EC2 instance for an Auto Scaling group, and the <code>Terminate</code> process removes an existing Amazon EC2 instance. <para> The remaining Auto Scaling process types relate to specific Auto Scaling features: <ul> <li>AddToLoadBalancer</li> <li>AlarmNotification</li> <li>AZRebalance</li> <li>HealthCheck</li> <li>ReplaceUnhealthy</li> <li>ScheduledActions</li> </ul> </para> <important> <para> If you suspend <code>Launch</code> or <code>Terminate</code>, all other process types are affected to varying degrees. The following descriptions discuss how each process type is affected by a suspension of <code>Launch</code> or <code>Terminate</code>. </para> </important> <para> The <code>AddToLoadBalancer</code> process type adds instances to the load balancer when the instances are launched. If you suspend this process, Auto Scaling will launch the instances but will not add them to the load balancer. If you resume the <code>AddToLoadBalancer</code> process, Auto Scaling will also resume adding new instances to the load balancer when they are launched. However, Auto Scaling will not add running instances that were launched while the process was suspended; those instances must be added manually using the the <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_RegisterInstancesWithLoadBalancer.html"> RegisterInstancesWithLoadBalancer</a> call in the <i>Elastic Load Balancing API Reference</i>. </para> <para> The <code>AlarmNotification</code> process type accepts notifications from Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you suspend the <code>AlarmNotification</code> process type, Auto Scaling will not automatically execute scaling policies that would be triggered by alarms. </para> <para> Although the <code>AlarmNotification</code> process type is not directly affected by a suspension of <code>Launch</code> or <code>Terminate</code>, alarm notifications are often used to signal that a change in the size of the Auto Scaling group is warranted. If you suspend <code>Launch</code> or <code>Terminate</code>, Auto Scaling might not be able to implement the alarm's associated policy. </para> <para> The <code>AZRebalance</code> process type seeks to maintain a balanced number of instances across Availability Zones within a Region. If you remove an Availability Zone from your Auto Scaling group or an Availability Zone otherwise becomes unhealthy or unavailable, Auto Scaling launches new instances in an unaffected Availability Zone before terminating the unhealthy or unavailable instances. When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically redistributes the application instances evenly across all of the designated Availability Zones. </para> <important> <para> If you call <a>SuspendProcesses</a> on the <code>launch</code> process type, the <code>AZRebalance</code> process will neither launch new instances nor terminate existing instances. This is because the <code>AZRebalance</code> process terminates existing instances only after launching the replacement instances. </para> <para> If you call <a>SuspendProcesses</a> on the <code>terminate</code> process type, the <code>AZRebalance</code> process can cause your Auto Scaling group to grow up to ten percent larger than the maximum size. This is because Auto Scaling allows groups to temporarily grow larger than the maximum size during rebalancing activities. If Auto Scaling cannot terminate instances, your Auto Scaling group could remain up to ten percent larger than the maximum size until you resume the <code>terminate</code> process type. </para> </important> <para> The <code>HealthCheck</code> process type checks the health of the instances. Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing informs Auto Scaling that the instance is unhealthy. The <code>HealthCheck</code> process can override the health status of an instance that you set with <a>SetInstanceHealth</a>. </para> <para> The <code>ReplaceUnhealthy</code> process type terminates instances that are marked as unhealthy and subsequently creates new instances to replace them. This process calls both of the primary process types--first <code>Terminate</code> and then <code>Launch</code>. </para> <important> <para> The <code>HealthCheck</code> process type works in conjunction with the <code>ReplaceUnhealthly</code> process type to provide health check functionality. If you suspend either <code>Launch</code> or <code>Terminate</code>, the <code>ReplaceUnhealthy</code> process type will not function properly. </para> </important> <para> The <code>ScheduledActions</code> process type performs scheduled actions that you create with <a>PutScheduledUpdateGroupAction</a>. Scheduled actions often involve launching new instances or terminating existing instances. If you suspend either <code>Launch</code> or <code>Terminate</code>, your scheduled actions might not function as expected. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.ProcessType.WithProcessName(System.String)"> <summary> Sets the ProcessName property </summary> <param name="processName">The value to set for the ProcessName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.ProcessType.ProcessName"> <summary> Gets and sets the property ProcessName. <para> The name of a process. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutLifecycleHookRequest"> <summary> Container for the parameters to the PutLifecycleHook operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithDefaultResult(System.String)"> <summary> Sets the DefaultResult property </summary> <param name="defaultResult">The value to set for the DefaultResult property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithHeartbeatTimeout(System.Int32)"> <summary> Sets the HeartbeatTimeout property </summary> <param name="heartbeatTimeout">The value to set for the HeartbeatTimeout property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithLifecycleHookName(System.String)"> <summary> Sets the LifecycleHookName property </summary> <param name="lifecycleHookName">The value to set for the LifecycleHookName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithLifecycleTransition(System.String)"> <summary> Sets the LifecycleTransition property </summary> <param name="lifecycleTransition">The value to set for the LifecycleTransition property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithNotificationMetadata(System.String)"> <summary> Sets the NotificationMetadata property </summary> <param name="notificationMetadata">The value to set for the NotificationMetadata property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithNotificationTargetARN(System.String)"> <summary> Sets the NotificationTargetARN property </summary> <param name="notificationTargetARN">The value to set for the NotificationTargetARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutLifecycleHookRequest.WithRoleARN(System.String)"> <summary> Sets the RoleARN property </summary> <param name="roleARN">The value to set for the RoleARN property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.DefaultResult"> <summary> Gets and sets the property DefaultResult. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.HeartbeatTimeout"> <summary> Gets and sets the property HeartbeatTimeout. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.LifecycleTransition"> <summary> Gets and sets the property LifecycleTransition. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.NotificationMetadata"> <summary> Gets and sets the property NotificationMetadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.NotificationTargetARN"> <summary> Gets and sets the property NotificationTargetARN. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.RoleARN"> <summary> Gets and sets the property RoleARN. </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutLifecycleHookResponse"> <summary> Returns information about the PutLifecycleHookResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookResponse.PutLifecycleHookResult"> <summary> Gets and sets the PutLifecycleHookResult property. Represents the output of a PutLifecycleHook operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutLifecycleHookResult"> <summary> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest"> <summary> Container for the parameters to the PutNotificationConfiguration operation. 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">Get Email Notifications When Your Auto Scaling Group Changes</a> </para> <para> A new <code>PutNotificationConfiguration</code> overwrites an existing configuration. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest.WithNotificationTypes(System.String[])"> <summary> Sets the NotificationTypes property </summary> <param name="notificationTypes">The values to add to the NotificationTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest.WithNotificationTypes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the NotificationTypes property </summary> <param name="notificationTypes">The values to add to the NotificationTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest.WithTopicARN(System.String)"> <summary> Sets the TopicARN property </summary> <param name="topicARN">The value to set for the TopicARN property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest.NotificationTypes"> <summary> Gets and sets the property NotificationTypes. <para> The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see <a>DescribeAutoScalingNotificationTypes</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutNotificationConfigurationRequest.TopicARN"> <summary> Gets and sets the property TopicARN. <para> The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutNotificationConfigurationResponse"> <summary> Returns information about the PutNotificationConfigurationResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutScalingPolicyRequest"> <summary> Container for the parameters to the PutScalingPolicy operation. Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameter(s) you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. </summary> </member> <member name="M:Amazon.AutoScaling.Model.PutScalingPolicyRequest.WithAdjustmentType(System.String)"> <summary> Sets the AdjustmentType property </summary> <param name="adjustmentType">The value to set for the AdjustmentType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScalingPolicyRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScalingPolicyRequest.WithCooldown(System.Int32)"> <summary> Sets the Cooldown property </summary> <param name="cooldown">The value to set for the Cooldown property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScalingPolicyRequest.WithMinAdjustmentStep(System.Int32)"> <summary> Sets the MinAdjustmentStep property </summary> <param name="minAdjustmentStep">The value to set for the MinAdjustmentStep property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScalingPolicyRequest.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScalingPolicyRequest.WithScalingAdjustment(System.Int32)"> <summary> Sets the ScalingAdjustment property </summary> <param name="scalingAdjustment">The value to set for the ScalingAdjustment property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.AdjustmentType"> <summary> Gets and sets the property AdjustmentType. <para> Specifies whether the <code>ScalingAdjustment</code> is an absolute number or a percentage of the current capacity. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>. </para> <para> For more information about the adjustment types supported by Auto Scaling, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html">Scale Based on Demand</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or ARN of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.Cooldown"> <summary> Gets and sets the property Cooldown. <para> The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AS_Concepts.html#Cooldown">Cooldown Period</a> </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.MinAdjustmentStep"> <summary> Gets and sets the property MinAdjustmentStep. <para> Used with <code>AdjustmentType</code> with the value <code>PercentChangeInCapacity</code>, the scaling policy changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least the number of instances specified in the value. </para> <para> You will get a <code>ValidationError</code> if you use <code>MinAdjustmentStep</code> on a policy with an <code>AdjustmentType</code> other than <code>PercentChangeInCapacity</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.PolicyName"> <summary> Gets and sets the property PolicyName. <para> The name of the policy you want to create or update. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.ScalingAdjustment"> <summary> Gets and sets the property ScalingAdjustment. <para> The number of instances by which to scale. <code>AdjustmentType</code> determines the interpretation of this number (e.g., as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacity. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutScalingPolicyResponse"> <summary> Returns information about the PutScalingPolicyResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyResponse.PutScalingPolicyResult"> <summary> Gets and sets the PutScalingPolicyResult property. Represents the output of a PutScalingPolicy operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutScalingPolicyResult"> <summary> The <code>PolicyARNType</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.PutScalingPolicyResult.WithPolicyARN(System.String)"> <summary> Sets the PolicyARN property </summary> <param name="policyARN">The value to set for the PolicyARN property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyResult.PolicyARN"> <summary> Gets and sets the property PolicyARN. <para> A policy's Amazon Resource Name (ARN). </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest"> <summary> Container for the parameters to the PutScheduledUpdateGroupAction operation. 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 information on creating or updating a scheduled action for your Auto Scaling group, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scale Based on a Schedule</a>. </para> <note> <para> Auto Scaling supports the date and time expressed in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only. </para> </note> </summary> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithDesiredCapacity(System.Int32)"> <summary> Sets the DesiredCapacity property </summary> <param name="desiredCapacity">The value to set for the DesiredCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithEndTime(System.DateTime)"> <summary> Sets the EndTime property </summary> <param name="endTime">The value to set for the EndTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithMaxSize(System.Int32)"> <summary> Sets the MaxSize property </summary> <param name="maxSize">The value to set for the MaxSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithMinSize(System.Int32)"> <summary> Sets the MinSize property </summary> <param name="minSize">The value to set for the MinSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithRecurrence(System.String)"> <summary> Sets the Recurrence property </summary> <param name="recurrence">The value to set for the Recurrence property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithScheduledActionName(System.String)"> <summary> Sets the ScheduledActionName property </summary> <param name="scheduledActionName">The value to set for the ScheduledActionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.WithTime(System.DateTime)"> <summary> Sets the Time property </summary> <param name="time">The value to set for the Time property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or ARN of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The number of Amazon EC2 instances that should be running in the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> The time for this action to end. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.MaxSize"> <summary> Gets and sets the property MaxSize. <para> The maximum size for the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.MinSize"> <summary> Gets and sets the property MinSize. <para> The minimum size for the new Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.Recurrence"> <summary> Gets and sets the property Recurrence. <para> The time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For information about cron syntax, go to <a href="http://en.wikipedia.org/wiki/Cron">Wikipedia, The Free Encyclopedia</a>. </para> <para> When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action will start and stop. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.ScheduledActionName"> <summary> Gets and sets the property ScheduledActionName. <para> The name of this scaling action. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> The time for this action to start, as in <code>--start-time 2010-06-01T00:00:00Z</code>. </para> <para> If you try to schedule your action in the past, Auto Scaling returns an error message. </para> <para> When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action will start and stop. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.Time"> <summary> Gets and sets the property Time. <para> <code>Time</code> is deprecated. </para> <para> The time for this action to start. <code>Time</code> is an alias for <code>StartTime</code> and can be specified instead of <code>StartTime</code>, or vice versa. If both <code>Time</code> and <code>StartTime</code> are specified, their values should be identical. Otherwise, <code>PutScheduledUpdateGroupAction</code> will return an error. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionResponse"> <summary> Returns information about the PutScheduledUpdateGroupActionResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest"> <summary> Container for the parameters to the RecordLifecycleActionHeartbeat operation. </summary> </member> <member name="M:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.WithLifecycleActionToken(System.String)"> <summary> Sets the LifecycleActionToken property </summary> <param name="lifecycleActionToken">The value to set for the LifecycleActionToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.WithLifecycleHookName(System.String)"> <summary> Sets the LifecycleHookName property </summary> <param name="lifecycleHookName">The value to set for the LifecycleHookName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. </summary> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.LifecycleActionToken"> <summary> Gets and sets the property LifecycleActionToken. </summary> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. </summary> </member> <member name="T:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse"> <summary> Returns information about the RecordLifecycleActionHeartbeatResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse.RecordLifecycleActionHeartbeatResult"> <summary> Gets and sets the RecordLifecycleActionHeartbeatResult property. Represents the output of a RecordLifecycleActionHeartbeat operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResult"> <summary> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ResourceInUseException"> <summary> AutoScaling exception </summary> </member> <member name="M:Amazon.AutoScaling.Model.ResourceInUseException.#ctor(System.String)"> <summary> Constructs a new ResourceInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AutoScaling.Model.ResumeProcessesRequest"> <summary> Container for the parameters to the ResumeProcesses operation. Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Process</a>. </summary> </member> <member name="M:Amazon.AutoScaling.Model.ResumeProcessesRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ResumeProcessesRequest.WithScalingProcesses(System.String[])"> <summary> Sets the ScalingProcesses property </summary> <param name="scalingProcesses">The values to add to the ScalingProcesses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ResumeProcessesRequest.WithScalingProcesses(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ScalingProcesses property </summary> <param name="scalingProcesses">The values to add to the ScalingProcesses collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.ResumeProcessesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or Amazon Resource Name (ARN) of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ResumeProcessesRequest.ScalingProcesses"> <summary> Gets and sets the property ScalingProcesses. <para> The processes that you want to suspend or resume, which can include one or more of the following: </para> <ul> <li>Launch</li> <li>Terminate</li> <li>HealthCheck</li> <li>ReplaceUnhealthy</li> <li>AZRebalance</li> <li>AlarmNotification</li> <li>ScheduledActions</li> <li>AddToLoadBalancer</li> </ul> <para> To suspend all process types, omit this parameter. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ResumeProcessesResponse"> <summary> Returns information about the ResumeProcessesResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> <summary> AutoScaling exception </summary> </member> <member name="M:Amazon.AutoScaling.Model.ScalingActivityInProgressException.#ctor(System.String)"> <summary> Constructs a new ScalingActivityInProgressException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AutoScaling.Model.ScalingPolicy"> <summary> The <code>ScalingPolicy</code> data type. </summary> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithAdjustmentType(System.String)"> <summary> Sets the AdjustmentType property </summary> <param name="adjustmentType">The value to set for the AdjustmentType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithAlarms(Amazon.AutoScaling.Model.Alarm[])"> <summary> Sets the Alarms property </summary> <param name="alarms">The values to add to the Alarms collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithAlarms(System.Collections.Generic.IEnumerable{Amazon.AutoScaling.Model.Alarm})"> <summary> Sets the Alarms property </summary> <param name="alarms">The values to add to the Alarms collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithCooldown(System.Int32)"> <summary> Sets the Cooldown property </summary> <param name="cooldown">The value to set for the Cooldown property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithMinAdjustmentStep(System.Int32)"> <summary> Sets the MinAdjustmentStep property </summary> <param name="minAdjustmentStep">The value to set for the MinAdjustmentStep property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithPolicyARN(System.String)"> <summary> Sets the PolicyARN property </summary> <param name="policyARN">The value to set for the PolicyARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScalingPolicy.WithScalingAdjustment(System.Int32)"> <summary> Sets the ScalingAdjustment property </summary> <param name="scalingAdjustment">The value to set for the ScalingAdjustment property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.AdjustmentType"> <summary> Gets and sets the property AdjustmentType. <para> Specifies whether the <code>ScalingAdjustment</code> is an absolute number or a percentage of the current capacity. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.Alarms"> <summary> Gets and sets the property Alarms. <para> A list of CloudWatch Alarms related to the policy. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group associated with this scaling policy. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.Cooldown"> <summary> Gets and sets the property Cooldown. <para> The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.MinAdjustmentStep"> <summary> Gets and sets the property MinAdjustmentStep. <para> Changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least the specified number of instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.PolicyARN"> <summary> Gets and sets the property PolicyARN. <para> The Amazon Resource Name (ARN) of the policy. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.PolicyName"> <summary> Gets and sets the property PolicyName. <para> The name of the scaling policy. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.ScalingAdjustment"> <summary> Gets and sets the property ScalingAdjustment. <para> The number associated with the specified adjustment type. A positive value adds to the current capacity and a negative value removes from the current capacity. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction"> <summary> This data type stores information about a scheduled update to an Auto Scaling group. </summary> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithDesiredCapacity(System.Int32)"> <summary> Sets the DesiredCapacity property </summary> <param name="desiredCapacity">The value to set for the DesiredCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithEndTime(System.DateTime)"> <summary> Sets the EndTime property </summary> <param name="endTime">The value to set for the EndTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithMaxSize(System.Int32)"> <summary> Sets the MaxSize property </summary> <param name="maxSize">The value to set for the MaxSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithMinSize(System.Int32)"> <summary> Sets the MinSize property </summary> <param name="minSize">The value to set for the MinSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithRecurrence(System.String)"> <summary> Sets the Recurrence property </summary> <param name="recurrence">The value to set for the Recurrence property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithScheduledActionARN(System.String)"> <summary> Sets the ScheduledActionARN property </summary> <param name="scheduledActionARN">The value to set for the ScheduledActionARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithScheduledActionName(System.String)"> <summary> Sets the ScheduledActionName property </summary> <param name="scheduledActionName">The value to set for the ScheduledActionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.WithTime(System.DateTime)"> <summary> Sets the Time property </summary> <param name="time">The value to set for the Time property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group to be updated. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The number of instances you prefer to maintain in your Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.EndTime"> <summary> Gets and sets the property EndTime. <para> The time that the action is scheduled to end. This value can be up to one month in the future. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.MaxSize"> <summary> Gets and sets the property MaxSize. <para> The maximum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.MinSize"> <summary> Gets and sets the property MinSize. <para> The minimum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.Recurrence"> <summary> Gets and sets the property Recurrence. <para> The regular schedule that an action occurs. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.ScheduledActionARN"> <summary> Gets and sets the property ScheduledActionARN. <para> The Amazon Resource Name (ARN) of this scheduled action. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.ScheduledActionName"> <summary> Gets and sets the property ScheduledActionName. <para> The name of this scheduled action. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.StartTime"> <summary> Gets and sets the property StartTime. <para> The time that the action is scheduled to begin. This value can be up to one month in the future. </para> <para> When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action will start and stop. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.Time"> <summary> Gets and sets the property Time. <para> <code>Time</code> is deprecated. </para> <para> The time that the action is scheduled to begin. <code>Time</code> is an alias for <code>StartTime</code>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetDesiredCapacityRequest"> <summary> Container for the parameters to the SetDesiredCapacity operation. Sets the desired size of the specified <a>AutoScalingGroup</a>. </summary> </member> <member name="M:Amazon.AutoScaling.Model.SetDesiredCapacityRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.SetDesiredCapacityRequest.WithDesiredCapacity(System.Int32)"> <summary> Sets the DesiredCapacity property </summary> <param name="desiredCapacity">The value to set for the DesiredCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.SetDesiredCapacityRequest.WithHonorCooldown(System.Boolean)"> <summary> Sets the HonorCooldown property </summary> <param name="honorCooldown">The value to set for the HonorCooldown property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.SetDesiredCapacityRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetDesiredCapacityRequest.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The new capacity setting for the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetDesiredCapacityRequest.HonorCooldown"> <summary> Gets and sets the property HonorCooldown. <para> By default, <code>SetDesiredCapacity</code> overrides any cooldown period associated with the Auto Scaling group. Set to <code>True</code> if you want Auto Scaling to wait for the cooldown period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to the new capacity setting. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetDesiredCapacityResponse"> <summary> Returns information about the SetDesiredCapacityResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetInstanceHealthRequest"> <summary> Container for the parameters to the SetInstanceHealth operation. Sets the health status of a specified instance that belongs to any of your Auto Scaling groups. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-configure-healthcheck.html">Configure Health Checks for Your Auto Scaling group</a>. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.SetInstanceHealthRequest.WithHealthStatus(System.String)"> <summary> Sets the HealthStatus property </summary> <param name="healthStatus">The value to set for the HealthStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.SetInstanceHealthRequest.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.SetInstanceHealthRequest.WithShouldRespectGracePeriod(System.Boolean)"> <summary> Sets the ShouldRespectGracePeriod property </summary> <param name="shouldRespectGracePeriod">The value to set for the ShouldRespectGracePeriod property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.SetInstanceHealthRequest.HealthStatus"> <summary> Gets and sets the property HealthStatus. <para> The health status of the instance. Set to <code>Healthy</code> if you want the instance to remain in service. Set to <code>Unhealthy</code> if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetInstanceHealthRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The identifier of the Amazon EC2 instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetInstanceHealthRequest.ShouldRespectGracePeriod"> <summary> Gets and sets the property ShouldRespectGracePeriod. <para> If the Auto Scaling group of the specified instance has a <code>HealthCheckGracePeriod</code> specified for the group, by default, this call will respect the grace period. Set this to <code>False</code>, if you do not want the call to respect the grace period associated with the group. </para> <para> For more information, see the <code>HealthCheckGracePeriod</code> parameter description in the <a>CreateAutoScalingGroup</a> action. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetInstanceHealthResponse"> <summary> Returns information about the SetInstanceHealthResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.SuspendedProcess"> <summary> An Auto Scaling process that has been suspended. For more information, see <a>ProcessType</a>. </summary> </member> <member name="M:Amazon.AutoScaling.Model.SuspendedProcess.WithProcessName(System.String)"> <summary> Sets the ProcessName property </summary> <param name="processName">The value to set for the ProcessName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.SuspendedProcess.WithSuspensionReason(System.String)"> <summary> Sets the SuspensionReason property </summary> <param name="suspensionReason">The value to set for the SuspensionReason property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.SuspendedProcess.ProcessName"> <summary> Gets and sets the property ProcessName. <para> The name of the suspended process. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SuspendedProcess.SuspensionReason"> <summary> Gets and sets the property SuspensionReason. <para> The reason that the process was suspended. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SuspendProcessesRequest"> <summary> Container for the parameters to the SuspendProcesses operation. Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the <code>ScalingProcesses.member.N</code> parameter. To suspend all process types, omit the <code>ScalingProcesses.member.N</code> parameter. <important> <para> Suspending either of the two primary process types, <code>Launch</code> or <code>Terminate</code>, can prevent other process types from functioning properly. </para> </important> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a> For more information on suspending and resuming Auto Scaling process, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspend and Resume Auto Scaling Process</a>. </para> </summary> </member> <member name="M:Amazon.AutoScaling.Model.SuspendProcessesRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.SuspendProcessesRequest.WithScalingProcesses(System.String[])"> <summary> Sets the ScalingProcesses property </summary> <param name="scalingProcesses">The values to add to the ScalingProcesses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.SuspendProcessesRequest.WithScalingProcesses(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ScalingProcesses property </summary> <param name="scalingProcesses">The values to add to the ScalingProcesses collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.SuspendProcessesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or Amazon Resource Name (ARN) of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SuspendProcessesRequest.ScalingProcesses"> <summary> Gets and sets the property ScalingProcesses. <para> The processes that you want to suspend or resume, which can include one or more of the following: </para> <ul> <li>Launch</li> <li>Terminate</li> <li>HealthCheck</li> <li>ReplaceUnhealthy</li> <li>AZRebalance</li> <li>AlarmNotification</li> <li>ScheduledActions</li> <li>AddToLoadBalancer</li> </ul> <para> To suspend all process types, omit this parameter. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SuspendProcessesResponse"> <summary> Returns information about the SuspendProcessesResult response and response metadata. </summary> </member> <member name="T:Amazon.AutoScaling.Model.Tag"> <summary> The tag applied to an Auto Scaling group. </summary> </member> <member name="M:Amazon.AutoScaling.Model.Tag.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Tag.WithPropagateAtLaunch(System.Boolean)"> <summary> Sets the PropagateAtLaunch property </summary> <param name="propagateAtLaunch">The value to set for the PropagateAtLaunch property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Tag.WithResourceId(System.String)"> <summary> Sets the ResourceId property </summary> <param name="resourceId">The value to set for the ResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Tag.WithResourceType(System.String)"> <summary> Sets the ResourceType property </summary> <param name="resourceType">The value to set for the ResourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.Tag.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> The key of the tag. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.PropagateAtLaunch"> <summary> Gets and sets the property PropagateAtLaunch. <para> Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The kind of resource to which the tag is applied. Currently, Auto Scaling supports the <code>auto-scaling-group</code> resource type. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> The value of the tag. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.TagDescription"> <summary> The tag applied to an Auto Scaling group. </summary> </member> <member name="M:Amazon.AutoScaling.Model.TagDescription.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.TagDescription.WithPropagateAtLaunch(System.Boolean)"> <summary> Sets the PropagateAtLaunch property </summary> <param name="propagateAtLaunch">The value to set for the PropagateAtLaunch property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.TagDescription.WithResourceId(System.String)"> <summary> Sets the ResourceId property </summary> <param name="resourceId">The value to set for the ResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.TagDescription.WithResourceType(System.String)"> <summary> Sets the ResourceType property </summary> <param name="resourceType">The value to set for the ResourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.TagDescription.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.Key"> <summary> Gets and sets the property Key. <para> The key of the tag. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.PropagateAtLaunch"> <summary> Gets and sets the property PropagateAtLaunch. <para> Specifies whether the new tag will be applied to instances launched after the tag is created. The same behavior applies to updates: If you change a tag, the changed tag will be applied to all instances launched after you made the change. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The kind of resource to which the tag is applied. Currently, Auto Scaling supports the <code>auto-scaling-group</code> resource type. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.Value"> <summary> Gets and sets the property Value. <para> The value of the tag. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest"> <summary> Container for the parameters to the TerminateInstanceInAutoScalingGroup operation. Terminates the specified instance. Optionally, the desired group size can be adjusted. <note> This call simply registers a termination request. The termination of the instance cannot happen immediately. </note> </summary> </member> <member name="M:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest.WithShouldDecrementDesiredCapacity(System.Boolean)"> <summary> Sets the ShouldDecrementDesiredCapacity property </summary> <param name="shouldDecrementDesiredCapacity">The value to set for the ShouldDecrementDesiredCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the Amazon EC2 instance to be terminated. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest.ShouldDecrementDesiredCapacity"> <summary> Gets and sets the property ShouldDecrementDesiredCapacity. <para> Specifies whether (<i>true</i>) or not (<i>false</i>) terminating this instance should also decrement the size of the <a>AutoScalingGroup</a>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupResponse"> <summary> Returns information about the TerminateInstanceInAutoScalingGroupResult response and response metadata. </summary> </member> <member name="P:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupResponse.TerminateInstanceInAutoScalingGroupResult"> <summary> Gets and sets the TerminateInstanceInAutoScalingGroupResult property. Represents the output of a TerminateInstanceInAutoScalingGroup operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupResult"> <summary> The output for the <a>TerminateInstanceInAutoScalingGroup</a> action. </summary> </member> <member name="M:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupResult.WithActivity(Amazon.AutoScaling.Model.Activity)"> <summary> Sets the Activity property </summary> <param name="activity">The value to set for the Activity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupResult.Activity"> <summary> Gets and sets the property Activity. <para> A scaling Activity. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest"> <summary> Container for the parameters to the UpdateAutoScalingGroup operation. Updates the configuration for the specified <a>AutoScalingGroup</a>. <note> <para> To update an Auto Scaling group with a launch configuration that has the <code>InstanceMonitoring</code> flag set to <code>False</code>, you must first ensure that collection of group metrics is disabled. Otherwise, calls to <a>UpdateAutoScalingGroup</a> will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling <a>DisableMetricsCollection</a>. </para> </note> <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> <note> <ul> <li> <para> If a new value is specified for <i>MinSize</i> without specifying the value for <i>DesiredCapacity</i>, and if the new <i>MinSize</i> is larger than the current size of the Auto Scaling Group, there will be an implicit call to <a>SetDesiredCapacity</a> to set the group to the new <i>MinSize</i>. </para> </li> <li> <para> If a new value is specified for <i>MaxSize</i> without specifying the value for <i>DesiredCapacity</i>, and the new <i>MaxSize</i> is smaller than the current size of the Auto Scaling Group, there will be an implicit call to <a>SetDesiredCapacity</a> to set the group to the new <i>MaxSize</i>. </para> </li> <li> <para> All other optional parameters are left unchanged if not passed in the request. </para> </li> </ul> </note> </summary> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithAutoScalingGroupName(System.String)"> <summary> Sets the AutoScalingGroupName property </summary> <param name="autoScalingGroupName">The value to set for the AutoScalingGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithAvailabilityZones(System.String[])"> <summary> Sets the AvailabilityZones property </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the AvailabilityZones property </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithDefaultCooldown(System.Int32)"> <summary> Sets the DefaultCooldown property </summary> <param name="defaultCooldown">The value to set for the DefaultCooldown property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithDesiredCapacity(System.Int32)"> <summary> Sets the DesiredCapacity property </summary> <param name="desiredCapacity">The value to set for the DesiredCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithHealthCheckGracePeriod(System.Int32)"> <summary> Sets the HealthCheckGracePeriod property </summary> <param name="healthCheckGracePeriod">The value to set for the HealthCheckGracePeriod property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithHealthCheckType(System.String)"> <summary> Sets the HealthCheckType property </summary> <param name="healthCheckType">The value to set for the HealthCheckType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithLaunchConfigurationName(System.String)"> <summary> Sets the LaunchConfigurationName property </summary> <param name="launchConfigurationName">The value to set for the LaunchConfigurationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithMaxSize(System.Int32)"> <summary> Sets the MaxSize property </summary> <param name="maxSize">The value to set for the MaxSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithMinSize(System.Int32)"> <summary> Sets the MinSize property </summary> <param name="minSize">The value to set for the MinSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithPlacementGroup(System.String)"> <summary> Sets the PlacementGroup property </summary> <param name="placementGroup">The value to set for the PlacementGroup property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithTerminationPolicies(System.String[])"> <summary> Sets the TerminationPolicies property </summary> <param name="terminationPolicies">The values to add to the TerminationPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithTerminationPolicies(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the TerminationPolicies property </summary> <param name="terminationPolicies">The values to add to the TerminationPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.WithVPCZoneIdentifier(System.String)"> <summary> Sets the VPCZoneIdentifier property </summary> <param name="vPCZoneIdentifier">The value to set for the VPCZoneIdentifier property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> Availability Zones for the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.DefaultCooldown"> <summary> Gets and sets the property DefaultCooldown. <para> The amount of time, in seconds, after a scaling activity completes before any further scaling activities can start. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AS_Concepts.html#Cooldown">Cooldown Period</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The desired capacity for the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.HealthCheckGracePeriod"> <summary> Gets and sets the property HealthCheckGracePeriod. <para> The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when the instance passes System Status and the Instance Status checks from Amazon EC2. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeInstanceStatus.html">DescribeInstanceStatus</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.HealthCheckType"> <summary> Gets and sets the property HealthCheckType. <para> The type of health check for the instances in the Auto Scaling group. The health check type can either be <code>EC2</code> for Amazon EC2 or <code>ELB</code> for Elastic Load Balancing. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> The name of the launch configuration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.MaxSize"> <summary> Gets and sets the property MaxSize. <para> The maximum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.MinSize"> <summary> Gets and sets the property MinSize. <para> The minimum size of the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.PlacementGroup"> <summary> Gets and sets the property PlacementGroup. <para> The name of the cluster placement group, if applicable. For more information, go to <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html"> Using Cluster Instances</a> in the Amazon EC2 User Guide. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.TerminationPolicies"> <summary> Gets and sets the property TerminationPolicies. <para> A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed. </para> <para> For more information on creating a termination policy for your Auto Scaling group, go to <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-termination-policy.html">Instance Termination Policy for Your Auto Scaling Group</a> in the the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.VPCZoneIdentifier"> <summary> Gets and sets the property VPCZoneIdentifier. <para> The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a comma-separated list. </para> <para> When you specify <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, ensure that the subnets' Availability Zones match the values you specify for <code>AvailabilityZones</code>. </para> <para> For more information on creating your Auto Scaling group in Amazon VPC by specifying subnets, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html">Launch Auto Scaling Instances into Amazon VPC</a> in the the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.UpdateAutoScalingGroupResponse"> <summary> Returns information about the UpdateAutoScalingGroupResult response and response metadata. </summary> </member> <member name="T:Amazon.AWSSupport.AmazonAWSSupport"> <summary> Interface for accessing AmazonAWSSupport. AWS Support <para>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions 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/support/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 actions: </para> <ul> <li> <b>Service names, issue categories, and available severity levels. </b> The actions DescribeServices and DescribeSeverityLevels enable you to obtain AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase action. </li> <li> <b>Case creation, case details, and case resolution.</b> The actions CreateCase, DescribeCases, and ResolveCase enable you to create AWS Support cases, retrieve them, and resolve them.</li> <li> <b>Case communication.</b> The actions DescribeCommunications and AddCommunicationToCase enable you to retrieve and add communication to AWS Support cases. </li> </ul> <para>The following list describes the actions available from the AWS Support service for Trusted Advisor:</para> <ul> <li> DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.</li> <li>Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified.</li> <li> DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.</li> <li> RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check. </li> <li> DescribeTrustedAdvisorCheckRefreshStatuses 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 the AWS Support <a href="http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html" >User Guide</a> 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.AmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"> <summary> <para>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 <c>AfterTime</c> and <c>BeforeTime</c> request parameters. </para> <para>The response returns the following in JSON format:</para> <ol> <li>One or more CaseDetails data types. </li> <li>One or more <c>NextToken</c> values, which specify where to paginate the returned records represented by the <c>CaseDetails</c> objects.</li> </ol> </summary> <param name="describeCasesRequest">Container for the necessary parameters to execute the DescribeCases service method on AmazonAWSSupport.</param> <returns>The response from the DescribeCases service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCases operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"/> </summary> <param name="describeCasesRequest">Container for the necessary parameters to execute the DescribeCases operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCases operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeCases(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCases operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCases.</param> <returns>Returns a DescribeCasesResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCases"> <summary> <para>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 <c>AfterTime</c> and <c>BeforeTime</c> request parameters. </para> <para>The response returns the following in JSON format:</para> <ol> <li>One or more CaseDetails data types. </li> <li>One or more <c>NextToken</c> values, which specify where to paginate the returned records represented by the <c>CaseDetails</c> objects.</li> </ol> </summary> <returns>The response from the DescribeCases service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"> <summary> <para>Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> </summary> <param name="describeTrustedAdvisorCheckRefreshStatusesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"/> </summary> <param name="describeTrustedAdvisorCheckRefreshStatusesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorCheckRefreshStatuses operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeTrustedAdvisorCheckRefreshStatuses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckRefreshStatuses.</param> <returns>Returns a DescribeTrustedAdvisorCheckRefreshStatusesResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"> <summary> <para>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 CaseDetails data type included in any CreateCase request. </para> </summary> <param name="describeSeverityLevelsRequest">Container for the necessary parameters to execute the DescribeSeverityLevels service method on AmazonAWSSupport.</param> <returns>The response from the DescribeSeverityLevels service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSeverityLevels operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"/> </summary> <param name="describeSeverityLevelsRequest">Container for the necessary parameters to execute the DescribeSeverityLevels operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSeverityLevels operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeSeverityLevels(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSeverityLevels operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSeverityLevels.</param> <returns>Returns a DescribeSeverityLevelsResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeSeverityLevels"> <summary> <para>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 CaseDetails data type included in any CreateCase request. </para> </summary> <returns>The response from the DescribeSeverityLevels service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"> <summary> <para>Returns communications regarding the support case. You can use the <c>AfterTime</c> and <c>BeforeTime</c> parameters to filter by date. The <c>CaseId</c> parameter enables you to identify a specific case by its <c>CaseId</c> value.</para> <para>The <c>MaxResults</c> and <c>NextToken</c> parameters enable you to control the pagination of the result set. Set <c>MaxResults</c> to the number of cases you want displayed on each page, and use <c>NextToken</c> to specify the resumption of pagination.</para> </summary> <param name="describeCommunicationsRequest">Container for the necessary parameters to execute the DescribeCommunications service method on AmazonAWSSupport.</param> <returns>The response from the DescribeCommunications service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCommunications operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"/> </summary> <param name="describeCommunicationsRequest">Container for the necessary parameters to execute the DescribeCommunications operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCommunications operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeCommunications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCommunications operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCommunications.</param> <returns>Returns a DescribeCommunicationsResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"> <summary> <para>Adds additional customer communication to an AWS Support case. You use the <c>CaseId</c> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <c>CcEmailAddresses</c> value. The <c>CommunicationBody</c> value contains the text of the communication.</para> <para>The response indicates the success or failure of the request.</para> <para>This operation implements a subset of the behavior on the AWS Support <a href="https://aws.amazon.com/support">Your Support Cases</a> web form.</para> </summary> <param name="addCommunicationToCaseRequest">Container for the necessary parameters to execute the AddCommunicationToCase service method on AmazonAWSSupport.</param> <returns>The response from the AddCommunicationToCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginAddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddCommunicationToCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"/> </summary> <param name="addCommunicationToCaseRequest">Container for the necessary parameters to execute the AddCommunicationToCase operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddCommunicationToCase operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndAddCommunicationToCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddCommunicationToCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddCommunicationToCase.</param> <returns>Returns a AddCommunicationToCaseResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"> <summary> <para>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page. Its parameters require you to specify the following information: </para> <ol> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <c>ServiceCode</c> by calling DescribeServices. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <c>ServiceCode</c> value. You also obtain the category code for a service by calling DescribeServices. 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 DescribeSeverityLevels.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page.</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://aws.amazon.com/support/createCase">Open a new 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> <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> </ol> <para><b>NOTE:</b> The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case. </para> <para>A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases action to retrieve existing AWS Support cases. </para> </summary> <param name="createCaseRequest">Container for the necessary parameters to execute the CreateCase service method on AmazonAWSSupport.</param> <returns>The response from the CreateCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginCreateCase(Amazon.AWSSupport.Model.CreateCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"/> </summary> <param name="createCaseRequest">Container for the necessary parameters to execute the CreateCase operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCase operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndCreateCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCase.</param> <returns>Returns a CreateCaseResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"> <summary> <para>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 TrustedAdvisorCheckDescription for each check.</para> </summary> <param name="describeTrustedAdvisorChecksRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorChecks service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"/> </summary> <param name="describeTrustedAdvisorChecksRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorChecks operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeTrustedAdvisorChecks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorChecks operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorChecks.</param> <returns>Returns a DescribeTrustedAdvisorChecksResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"> <summary> <para>Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains a TrustedAdvisorCheckResult object, which contains these three objects:</para> <ul> <li> TrustedAdvisorCategorySpecificSummary </li> <li> TrustedAdvisorResourceDetail </li> <li> TrustedAdvisorResourcesSummary </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="describeTrustedAdvisorCheckResultRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorCheckResult service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"/> </summary> <param name="describeTrustedAdvisorCheckResultRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorCheckResult operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeTrustedAdvisorCheckResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckResult.</param> <returns>Returns a DescribeTrustedAdvisorCheckResultResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"> <summary> <para>Takes a <c>CaseId</c> and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.</para> </summary> <param name="resolveCaseRequest">Container for the necessary parameters to execute the ResolveCase service method on AmazonAWSSupport.</param> <returns>The response from the ResolveCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResolveCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"/> </summary> <param name="resolveCaseRequest">Container for the necessary parameters to execute the ResolveCase operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResolveCase operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndResolveCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResolveCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResolveCase.</param> <returns>Returns a ResolveCaseResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.ResolveCase"> <summary> <para>Takes a <c>CaseId</c> and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.</para> </summary> <returns>The response from the ResolveCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"> <summary> <para>Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains a RefreshTrustedAdvisorCheckResult 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="refreshTrustedAdvisorCheckRequest">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method on AmazonAWSSupport.</param> <returns>The response from the RefreshTrustedAdvisorCheck service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginRefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"/> </summary> <param name="refreshTrustedAdvisorCheckRequest">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRefreshTrustedAdvisorCheck operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndRefreshTrustedAdvisorCheck(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RefreshTrustedAdvisorCheck operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRefreshTrustedAdvisorCheck.</param> <returns>Returns a RefreshTrustedAdvisorCheckResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"> <summary> <para>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 CreateCase requests. Each AWS service has its own set of categories.</para> <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://aws.amazon.com/support/createCase">Open a new case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <c>DescribeServices</c> 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="describeServicesRequest">Container for the necessary parameters to execute the DescribeServices service method on AmazonAWSSupport.</param> <returns>The response from the DescribeServices service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"/> </summary> <param name="describeServicesRequest">Container for the necessary parameters to execute the DescribeServices operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeServices operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServices operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServices.</param> <returns>Returns a DescribeServicesResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeServices"> <summary> <para>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 CreateCase requests. Each AWS service has its own set of categories.</para> <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://aws.amazon.com/support/createCase">Open a new case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <c>DescribeServices</c> 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 AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"> <summary> <para>Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains an array of TrustedAdvisorCheckSummary objects.</para> </summary> <param name="describeTrustedAdvisorCheckSummariesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.BeginDescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"/> </summary> <param name="describeTrustedAdvisorCheckSummariesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorCheckSummaries operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupport.EndDescribeTrustedAdvisorCheckSummaries(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckSummaries.</param> <returns>Returns a DescribeTrustedAdvisorCheckSummariesResult from AmazonAWSSupport.</returns> </member> <member name="T:Amazon.AWSSupport.AmazonAWSSupportClient"> <summary> Implementation for accessing AmazonAWSSupport. AWS Support <para>The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions 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/support/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 actions: </para> <ul> <li> <b>Service names, issue categories, and available severity levels. </b> The actions DescribeServices and DescribeSeverityLevels enable you to obtain AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase action. </li> <li> <b>Case creation, case details, and case resolution.</b> The actions CreateCase, DescribeCases, and ResolveCase enable you to create AWS Support cases, retrieve them, and resolve them.</li> <li> <b>Case communication.</b> The actions DescribeCommunications and AddCommunicationToCase enable you to retrieve and add communication to AWS Support cases. </li> </ul> <para>The following list describes the actions available from the AWS Support service for Trusted Advisor:</para> <ul> <li> DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.</li> <li>Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified.</li> <li> DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.</li> <li> RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check. </li> <li> DescribeTrustedAdvisorCheckRefreshStatuses 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 the AWS Support <a href="http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html" >User Guide</a> 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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonAWSSupport 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"> <summary> <para>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 <c>AfterTime</c> and <c>BeforeTime</c> request parameters. </para> <para>The response returns the following in JSON format:</para> <ol> <li>One or more CaseDetails data types. </li> <li>One or more <c>NextToken</c> values, which specify where to paginate the returned records represented by the <c>CaseDetails</c> objects.</li> </ol> </summary> <param name="describeCasesRequest">Container for the necessary parameters to execute the DescribeCases service method on AmazonAWSSupport.</param> <returns>The response from the DescribeCases service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCases operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"/> </summary> <param name="describeCasesRequest">Container for the necessary parameters to execute the DescribeCases operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCases operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeCases(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCases operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCases.</param> <returns>Returns a DescribeCasesResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCases"> <summary> <para>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 <c>AfterTime</c> and <c>BeforeTime</c> request parameters. </para> <para>The response returns the following in JSON format:</para> <ol> <li>One or more CaseDetails data types. </li> <li>One or more <c>NextToken</c> values, which specify where to paginate the returned records represented by the <c>CaseDetails</c> objects.</li> </ol> </summary> <returns>The response from the DescribeCases service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"> <summary> <para>Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> </summary> <param name="describeTrustedAdvisorCheckRefreshStatusesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"/> </summary> <param name="describeTrustedAdvisorCheckRefreshStatusesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorCheckRefreshStatuses operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeTrustedAdvisorCheckRefreshStatuses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckRefreshStatuses.</param> <returns>Returns a DescribeTrustedAdvisorCheckRefreshStatusesResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"> <summary> <para>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 CaseDetails data type included in any CreateCase request. </para> </summary> <param name="describeSeverityLevelsRequest">Container for the necessary parameters to execute the DescribeSeverityLevels service method on AmazonAWSSupport.</param> <returns>The response from the DescribeSeverityLevels service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSeverityLevels operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"/> </summary> <param name="describeSeverityLevelsRequest">Container for the necessary parameters to execute the DescribeSeverityLevels operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSeverityLevels operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeSeverityLevels(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSeverityLevels operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSeverityLevels.</param> <returns>Returns a DescribeSeverityLevelsResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeSeverityLevels"> <summary> <para>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 CaseDetails data type included in any CreateCase request. </para> </summary> <returns>The response from the DescribeSeverityLevels service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"> <summary> <para>Returns communications regarding the support case. You can use the <c>AfterTime</c> and <c>BeforeTime</c> parameters to filter by date. The <c>CaseId</c> parameter enables you to identify a specific case by its <c>CaseId</c> value.</para> <para>The <c>MaxResults</c> and <c>NextToken</c> parameters enable you to control the pagination of the result set. Set <c>MaxResults</c> to the number of cases you want displayed on each page, and use <c>NextToken</c> to specify the resumption of pagination.</para> </summary> <param name="describeCommunicationsRequest">Container for the necessary parameters to execute the DescribeCommunications service method on AmazonAWSSupport.</param> <returns>The response from the DescribeCommunications service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCommunications operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"/> </summary> <param name="describeCommunicationsRequest">Container for the necessary parameters to execute the DescribeCommunications operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCommunications operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeCommunications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCommunications operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCommunications.</param> <returns>Returns a DescribeCommunicationsResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"> <summary> <para>Adds additional customer communication to an AWS Support case. You use the <c>CaseId</c> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <c>CcEmailAddresses</c> value. The <c>CommunicationBody</c> value contains the text of the communication.</para> <para>The response indicates the success or failure of the request.</para> <para>This operation implements a subset of the behavior on the AWS Support <a href="https://aws.amazon.com/support">Your Support Cases</a> web form.</para> </summary> <param name="addCommunicationToCaseRequest">Container for the necessary parameters to execute the AddCommunicationToCase service method on AmazonAWSSupport.</param> <returns>The response from the AddCommunicationToCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginAddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddCommunicationToCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"/> </summary> <param name="addCommunicationToCaseRequest">Container for the necessary parameters to execute the AddCommunicationToCase operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddCommunicationToCase operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndAddCommunicationToCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddCommunicationToCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddCommunicationToCase.</param> <returns>Returns a AddCommunicationToCaseResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"> <summary> <para>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page. Its parameters require you to specify the following information: </para> <ol> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <c>ServiceCode</c> by calling DescribeServices. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <c>ServiceCode</c> value. You also obtain the category code for a service by calling DescribeServices. 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 DescribeSeverityLevels.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page.</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://aws.amazon.com/support/createCase">Open a new 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> <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> </ol> <para><b>NOTE:</b> The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case. </para> <para>A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases action to retrieve existing AWS Support cases. </para> </summary> <param name="createCaseRequest">Container for the necessary parameters to execute the CreateCase service method on AmazonAWSSupport.</param> <returns>The response from the CreateCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginCreateCase(Amazon.AWSSupport.Model.CreateCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"/> </summary> <param name="createCaseRequest">Container for the necessary parameters to execute the CreateCase operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCase operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndCreateCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCase.</param> <returns>Returns a CreateCaseResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"> <summary> <para>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 TrustedAdvisorCheckDescription for each check.</para> </summary> <param name="describeTrustedAdvisorChecksRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorChecks service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"/> </summary> <param name="describeTrustedAdvisorChecksRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorChecks operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeTrustedAdvisorChecks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorChecks operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorChecks.</param> <returns>Returns a DescribeTrustedAdvisorChecksResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"> <summary> <para>Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains a TrustedAdvisorCheckResult object, which contains these three objects:</para> <ul> <li> TrustedAdvisorCategorySpecificSummary </li> <li> TrustedAdvisorResourceDetail </li> <li> TrustedAdvisorResourcesSummary </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="describeTrustedAdvisorCheckResultRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorCheckResult service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"/> </summary> <param name="describeTrustedAdvisorCheckResultRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorCheckResult operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeTrustedAdvisorCheckResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckResult.</param> <returns>Returns a DescribeTrustedAdvisorCheckResultResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"> <summary> <para>Takes a <c>CaseId</c> and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.</para> </summary> <param name="resolveCaseRequest">Container for the necessary parameters to execute the ResolveCase service method on AmazonAWSSupport.</param> <returns>The response from the ResolveCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResolveCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"/> </summary> <param name="resolveCaseRequest">Container for the necessary parameters to execute the ResolveCase operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResolveCase operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndResolveCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResolveCase operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResolveCase.</param> <returns>Returns a ResolveCaseResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.ResolveCase"> <summary> <para>Takes a <c>CaseId</c> and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.</para> </summary> <returns>The response from the ResolveCase service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"> <summary> <para>Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains a RefreshTrustedAdvisorCheckResult 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="refreshTrustedAdvisorCheckRequest">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method on AmazonAWSSupport.</param> <returns>The response from the RefreshTrustedAdvisorCheck service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginRefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"/> </summary> <param name="refreshTrustedAdvisorCheckRequest">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRefreshTrustedAdvisorCheck operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndRefreshTrustedAdvisorCheck(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RefreshTrustedAdvisorCheck operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRefreshTrustedAdvisorCheck.</param> <returns>Returns a RefreshTrustedAdvisorCheckResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"> <summary> <para>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 CreateCase requests. Each AWS service has its own set of categories.</para> <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://aws.amazon.com/support/createCase">Open a new case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <c>DescribeServices</c> 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="describeServicesRequest">Container for the necessary parameters to execute the DescribeServices service method on AmazonAWSSupport.</param> <returns>The response from the DescribeServices service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"/> </summary> <param name="describeServicesRequest">Container for the necessary parameters to execute the DescribeServices operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeServices operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServices operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServices.</param> <returns>Returns a DescribeServicesResult from AmazonAWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeServices"> <summary> <para>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 CreateCase requests. Each AWS service has its own set of categories.</para> <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://aws.amazon.com/support/createCase">Open a new case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <c>DescribeServices</c> 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 AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"> <summary> <para>Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains an array of TrustedAdvisorCheckSummary objects.</para> </summary> <param name="describeTrustedAdvisorCheckSummariesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method on AmazonAWSSupport.</param> <returns>The response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AmazonAWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"/> </summary> <param name="describeTrustedAdvisorCheckSummariesRequest">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation on AmazonAWSSupport.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrustedAdvisorCheckSummaries operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeTrustedAdvisorCheckSummaries(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckSummaries.</param> <returns>Returns a DescribeTrustedAdvisorCheckSummariesResult from AmazonAWSSupport.</returns> </member> <member name="T:Amazon.AWSSupport.AmazonAWSSupportConfig"> <summary> Configuration for accessing AWS Support service </summary> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.AWSSupport.AmazonAWSSupportConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.AWSSupport.AmazonAWSSupportConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest"> <summary> Container for the parameters to the AddCommunicationToCase operation. <para>Adds additional customer communication to an AWS Support case. You use the <c>CaseId</c> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <c>CcEmailAddresses</c> value. The <c>CommunicationBody</c> value contains the text of the communication.</para> <para>The response indicates the success or failure of the request.</para> <para>This operation implements a subset of the behavior on the AWS Support <a href="https://aws.amazon.com/support">Your Support Cases</a> web form.</para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.WithCaseId(System.String)"> <summary> Sets the CaseId property </summary> <param name="caseId">The value to set for the CaseId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.WithCommunicationBody(System.String)"> <summary> Sets the CommunicationBody property </summary> <param name="communicationBody">The value to set for the CommunicationBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.WithCcEmailAddresses(System.String[])"> <summary> Adds elements to the CcEmailAddresses collection </summary> <param name="ccEmailAddresses">The values to add to the CcEmailAddresses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.WithCcEmailAddresses(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CcEmailAddresses collection </summary> <param name="ccEmailAddresses">The values to add to the CcEmailAddresses collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.CaseId"> <summary> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.CommunicationBody"> <summary> The body of an email communication to add to the support case. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 8000</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.CcEmailAddresses"> <summary> The email addresses in the CC line of an email to be added to the support case. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddCommunicationToCaseResponse"> <summary> Returns information about the AddCommunicationToCaseResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseResponse.AddCommunicationToCaseResult"> <summary> Gets and sets the AddCommunicationToCaseResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddCommunicationToCaseResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.AddCommunicationToCaseResult.WithResult(System.Boolean)"> <summary> Sets the Result property </summary> <param name="result">The value to set for the Result property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseResult.Result"> <summary> True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"> <summary> AmazonAWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.CaseCreationLimitExceededException.#ctor(System.String)"> <summary> Constructs a new CaseCreationLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.CaseDetails"> <summary> <para>A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. <b>CaseDetails</b> contains the following fields:</para> <ol> <li> <b>CaseID.</b> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case- <i>12345678910-2013-c4c1d2bf33c5cf47</i> .</li> <li> <b>CategoryCode.</b> The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.</li> <li> <b>DisplayId.</b> The identifier for the case on pages in the AWS Support Center.</li> <li> <b>Language.</b> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.</li> <li> <b>RecentCommunications.</b> One or more Communication objects. Fields of these objects are <c>Body</c> , <c>CaseId</c> , <c>SubmittedBy</c> , and <c>TimeCreated</c> .</li> <li> <b>NextToken.</b> A resumption point for pagination.</li> <li> <b>ServiceCode.</b> The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.</li> <li> <b>SeverityCode. </b> The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels.</li> <li> <b>Status.</b> The status of the case in the AWS Support Center.</li> <li> <b>Subject.</b> The subject line of the case.</li> <li> <b>SubmittedBy.</b> The email address of the account that submitted the case.</li> <li> <b>TimeCreated.</b> The time the case was created, in ISO-8601 format.</li> </ol> </summary> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithCaseId(System.String)"> <summary> Sets the CaseId property </summary> <param name="caseId">The value to set for the CaseId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithDisplayId(System.String)"> <summary> Sets the DisplayId property </summary> <param name="displayId">The value to set for the DisplayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithSubject(System.String)"> <summary> Sets the Subject property </summary> <param name="subject">The value to set for the Subject property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithServiceCode(System.String)"> <summary> Sets the ServiceCode property </summary> <param name="serviceCode">The value to set for the ServiceCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithCategoryCode(System.String)"> <summary> Sets the CategoryCode property </summary> <param name="categoryCode">The value to set for the CategoryCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithSeverityCode(System.String)"> <summary> Sets the SeverityCode property </summary> <param name="severityCode">The value to set for the SeverityCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithSubmittedBy(System.String)"> <summary> Sets the SubmittedBy property </summary> <param name="submittedBy">The value to set for the SubmittedBy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithTimeCreated(System.String)"> <summary> Sets the TimeCreated property </summary> <param name="timeCreated">The value to set for the TimeCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithRecentCommunications(Amazon.AWSSupport.Model.RecentCaseCommunications)"> <summary> Sets the RecentCommunications property </summary> <param name="recentCommunications">The value to set for the RecentCommunications property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithCcEmailAddresses(System.String[])"> <summary> Adds elements to the CcEmailAddresses collection </summary> <param name="ccEmailAddresses">The values to add to the CcEmailAddresses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithCcEmailAddresses(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CcEmailAddresses collection </summary> <param name="ccEmailAddresses">The values to add to the CcEmailAddresses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CaseDetails.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.CaseId"> <summary> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.DisplayId"> <summary> The ID displayed for the case in the AWS Support Center. This is a numeric string. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.Subject"> <summary> The subject line for the case in the AWS Support Center. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.Status"> <summary> The status of the case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.ServiceCode"> <summary> The code for the AWS service returned by the call to <a>DescribeServices</a>. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.CategoryCode"> <summary> The category of problem for the AWS Support case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.SeverityCode"> <summary> The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.SubmittedBy"> <summary> The email address of the account that submitted the case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.TimeCreated"> <summary> The time that the case was case created in the AWS Support Center. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.RecentCommunications"> <summary> The five most recent communications between you and AWS Support Center. Includes a <c>nextToken</c> to retrieve the next set of communications. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.CcEmailAddresses"> <summary> The email addresses that receive copies of communication about the case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.Language"> <summary> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. </summary> </member> <member name="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> <summary> AmazonAWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.CaseIdNotFoundException.#ctor(System.String)"> <summary> Constructs a new CaseIdNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.Category"> <summary> <para>A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.Category.WithCode(System.String)"> <summary> Sets the Code property </summary> <param name="code">The value to set for the Code property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.Category.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.Category.Code"> <summary> The category code for the support case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Category.Name"> <summary> The category name for the support case. </summary> </member> <member name="T:Amazon.AWSSupport.Model.Communication"> <summary> <para>Exposes the fields used by a communication for an AWS Support case.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.Communication.WithCaseId(System.String)"> <summary> Sets the CaseId property </summary> <param name="caseId">The value to set for the CaseId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.Communication.WithBody(System.String)"> <summary> Sets the Body property </summary> <param name="body">The value to set for the Body property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.Communication.WithSubmittedBy(System.String)"> <summary> Sets the SubmittedBy property </summary> <param name="submittedBy">The value to set for the SubmittedBy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.Communication.WithTimeCreated(System.String)"> <summary> Sets the TimeCreated property </summary> <param name="timeCreated">The value to set for the TimeCreated property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.Communication.CaseId"> <summary> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.Body"> <summary> The text of the communication between the customer and AWS Support. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.SubmittedBy"> <summary> The email address of the account that submitted the AWS Support case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.TimeCreated"> <summary> The time the support case was created. </summary> </member> <member name="T:Amazon.AWSSupport.Model.CreateCaseRequest"> <summary> Container for the parameters to the CreateCase operation. <para>Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page. Its parameters require you to specify the following information: </para> <ol> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <c>ServiceCode</c> by calling DescribeServices. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <c>ServiceCode</c> value. You also obtain the category code for a service by calling DescribeServices. 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 DescribeSeverityLevels.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://aws.amazon.com/support/createCase">Open a new case</a> page.</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://aws.amazon.com/support/createCase">Open a new 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> <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> </ol> <para><b>NOTE:</b> The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case. </para> <para>A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases action to retrieve existing AWS Support cases. </para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithSubject(System.String)"> <summary> Sets the Subject property </summary> <param name="subject">The value to set for the Subject property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithServiceCode(System.String)"> <summary> Sets the ServiceCode property </summary> <param name="serviceCode">The value to set for the ServiceCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithSeverityCode(System.String)"> <summary> Sets the SeverityCode property </summary> <param name="severityCode">The value to set for the SeverityCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithCategoryCode(System.String)"> <summary> Sets the CategoryCode property </summary> <param name="categoryCode">The value to set for the CategoryCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithCommunicationBody(System.String)"> <summary> Sets the CommunicationBody property </summary> <param name="communicationBody">The value to set for the CommunicationBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithCcEmailAddresses(System.String[])"> <summary> Adds elements to the CcEmailAddresses collection </summary> <param name="ccEmailAddresses">The values to add to the CcEmailAddresses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithCcEmailAddresses(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CcEmailAddresses collection </summary> <param name="ccEmailAddresses">The values to add to the CcEmailAddresses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseRequest.WithIssueType(System.String)"> <summary> Sets the IssueType property </summary> <param name="issueType">The value to set for the IssueType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.Subject"> <summary> The title of the AWS Support case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.ServiceCode"> <summary> The code for the AWS service returned by the call to <a>DescribeServices</a>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>[0-9a-z\-_]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.SeverityCode"> <summary> The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>. <note>The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.</note> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.CategoryCode"> <summary> The category of problem for the AWS Support case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.CommunicationBody"> <summary> The communication body text when you create an AWS Support case by calling <a>CreateCase</a>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 8000</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.CcEmailAddresses"> <summary> A list of email addresses that AWS Support copies on case correspondence. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.Language"> <summary> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.IssueType"> <summary> 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." </summary> </member> <member name="T:Amazon.AWSSupport.Model.CreateCaseResponse"> <summary> Returns information about the CreateCaseResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseResponse.CreateCaseResult"> <summary> Gets and sets the CreateCaseResult property. The AWS Support case ID returned by a successful completion of the CreateCase action. </summary> </member> <member name="T:Amazon.AWSSupport.Model.CreateCaseResult"> <summary> <para>The AWS Support case ID returned by a successful completion of the CreateCase action. </para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.CreateCaseResult.WithCaseId(System.String)"> <summary> Sets the CaseId property </summary> <param name="caseId">The value to set for the CaseId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseResult.CaseId"> <summary> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCasesRequest"> <summary> Container for the parameters to the DescribeCases operation. <para>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 <c>AfterTime</c> and <c>BeforeTime</c> request parameters. </para> <para>The response returns the following in JSON format:</para> <ol> <li>One or more CaseDetails data types. </li> <li>One or more <c>NextToken</c> values, which specify where to paginate the returned records represented by the <c>CaseDetails</c> objects.</li> </ol> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithCaseIdList(System.String[])"> <summary> Adds elements to the CaseIdList collection </summary> <param name="caseIdList">The values to add to the CaseIdList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithCaseIdList(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CaseIdList collection </summary> <param name="caseIdList">The values to add to the CaseIdList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithDisplayId(System.String)"> <summary> Sets the DisplayId property </summary> <param name="displayId">The value to set for the DisplayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithAfterTime(System.String)"> <summary> Sets the AfterTime property </summary> <param name="afterTime">The value to set for the AfterTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithBeforeTime(System.String)"> <summary> Sets the BeforeTime property </summary> <param name="beforeTime">The value to set for the BeforeTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithIncludeResolvedCases(System.Boolean)"> <summary> Sets the IncludeResolvedCases property </summary> <param name="includeResolvedCases">The value to set for the IncludeResolvedCases property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithMaxResults(System.Int32)"> <summary> Sets the MaxResults property </summary> <param name="maxResults">The value to set for the MaxResults property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesRequest.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.CaseIdList"> <summary> A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.DisplayId"> <summary> The ID displayed for a case in the AWS Support Center user interface. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.AfterTime"> <summary> The start date for a filtered date search on support case communications. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.BeforeTime"> <summary> The end date for a filtered date search on support case communications. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.IncludeResolvedCases"> <summary> Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.NextToken"> <summary> A resumption point for pagination. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.MaxResults"> <summary> The maximum number of results to return before paginating. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>10 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.Language"> <summary> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCasesResponse"> <summary> Returns information about the DescribeCasesResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesResponse.DescribeCasesResult"> <summary> Gets and sets the DescribeCasesResult property. Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCasesResult"> <summary> <para>Returns an array of CaseDetails objects and a <c>NextToken</c> that defines a point for pagination in the result set.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesResult.WithCases(Amazon.AWSSupport.Model.CaseDetails[])"> <summary> Adds elements to the Cases collection </summary> <param name="cases">The values to add to the Cases collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesResult.WithCases(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.CaseDetails})"> <summary> Adds elements to the Cases collection </summary> <param name="cases">The values to add to the Cases collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCasesResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesResult.Cases"> <summary> The details for the cases that match the request. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesResult.NextToken"> <summary> A resumption point for pagination. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCommunicationsRequest"> <summary> Container for the parameters to the DescribeCommunications operation. <para>Returns communications regarding the support case. You can use the <c>AfterTime</c> and <c>BeforeTime</c> parameters to filter by date. The <c>CaseId</c> parameter enables you to identify a specific case by its <c>CaseId</c> value.</para> <para>The <c>MaxResults</c> and <c>NextToken</c> parameters enable you to control the pagination of the result set. Set <c>MaxResults</c> to the number of cases you want displayed on each page, and use <c>NextToken</c> to specify the resumption of pagination.</para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.WithCaseId(System.String)"> <summary> Sets the CaseId property </summary> <param name="caseId">The value to set for the CaseId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.WithBeforeTime(System.String)"> <summary> Sets the BeforeTime property </summary> <param name="beforeTime">The value to set for the BeforeTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.WithAfterTime(System.String)"> <summary> Sets the AfterTime property </summary> <param name="afterTime">The value to set for the AfterTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.WithMaxResults(System.Int32)"> <summary> Sets the MaxResults property </summary> <param name="maxResults">The value to set for the MaxResults property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.CaseId"> <summary> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.BeforeTime"> <summary> The end date for a filtered date search on support case communications. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.AfterTime"> <summary> The start date for a filtered date search on support case communications. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.NextToken"> <summary> A resumption point for pagination. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.MaxResults"> <summary> The maximum number of results to return before paginating. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>10 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCommunicationsResponse"> <summary> Returns information about the DescribeCommunicationsResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsResponse.DescribeCommunicationsResult"> <summary> Gets and sets the DescribeCommunicationsResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCommunicationsResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsResult.WithCommunications(Amazon.AWSSupport.Model.Communication[])"> <summary> Adds elements to the Communications collection </summary> <param name="communications">The values to add to the Communications collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsResult.WithCommunications(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.Communication})"> <summary> Adds elements to the Communications collection </summary> <param name="communications">The values to add to the Communications collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeCommunicationsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsResult.Communications"> <summary> The communications for the case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsResult.NextToken"> <summary> A resumption point for pagination. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeServicesRequest"> <summary> Container for the parameters to the DescribeServices operation. <para>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 CreateCase requests. Each AWS service has its own set of categories.</para> <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://aws.amazon.com/support/createCase">Open a new case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <c>DescribeServices</c> 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> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeServicesRequest.WithServiceCodeList(System.String[])"> <summary> Adds elements to the ServiceCodeList collection </summary> <param name="serviceCodeList">The values to add to the ServiceCodeList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeServicesRequest.WithServiceCodeList(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the ServiceCodeList collection </summary> <param name="serviceCodeList">The values to add to the ServiceCodeList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeServicesRequest.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesRequest.ServiceCodeList"> <summary> A JSON-formatted list of service codes available for AWS services. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesRequest.Language"> <summary> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeServicesResponse"> <summary> Returns information about the DescribeServicesResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesResponse.DescribeServicesResult"> <summary> Gets and sets the DescribeServicesResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeServicesResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeServicesResult.WithServices(Amazon.AWSSupport.Model.Service[])"> <summary> Adds elements to the Services collection </summary> <param name="services">The values to add to the Services collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeServicesResult.WithServices(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.Service})"> <summary> Adds elements to the Services collection </summary> <param name="services">The values to add to the Services collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesResult.Services"> <summary> A JSON-formatted list of AWS services. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest"> <summary> Container for the parameters to the DescribeSeverityLevels operation. <para>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 CaseDetails data type included in any CreateCase request. </para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest.Language"> <summary> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeSeverityLevelsResponse"> <summary> Returns information about the DescribeSeverityLevelsResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeSeverityLevelsResponse.DescribeSeverityLevelsResult"> <summary> Gets and sets the DescribeSeverityLevelsResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeSeverityLevelsResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeSeverityLevelsResult.WithSeverityLevels(Amazon.AWSSupport.Model.SeverityLevel[])"> <summary> Adds elements to the SeverityLevels collection </summary> <param name="severityLevels">The values to add to the SeverityLevels collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeSeverityLevelsResult.WithSeverityLevels(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.SeverityLevel})"> <summary> Adds elements to the SeverityLevels collection </summary> <param name="severityLevels">The values to add to the SeverityLevels collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeSeverityLevelsResult.SeverityLevels"> <summary> The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorCheckRefreshStatuses operation. <para>Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest.WithCheckIds(System.String[])"> <summary> Adds elements to the CheckIds collection </summary> <param name="checkIds">The values to add to the CheckIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest.WithCheckIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CheckIds collection </summary> <param name="checkIds">The values to add to the CheckIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest.CheckIds"> <summary> The IDs of the Trusted Advisor checks. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResponse"> <summary> Returns information about the DescribeTrustedAdvisorCheckRefreshStatusesResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResponse.DescribeTrustedAdvisorCheckRefreshStatusesResult"> <summary> Gets and sets the DescribeTrustedAdvisorCheckRefreshStatusesResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResult.WithStatuses(Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus[])"> <summary> Adds elements to the Statuses collection </summary> <param name="statuses">The values to add to the Statuses collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResult.WithStatuses(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus})"> <summary> Adds elements to the Statuses collection </summary> <param name="statuses">The values to add to the Statuses collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResult.Statuses"> <summary> The refresh status of the specified Trusted Advisor checks. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorCheckResult operation. <para>Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains a TrustedAdvisorCheckResult object, which contains these three objects:</para> <ul> <li> TrustedAdvisorCategorySpecificSummary </li> <li> TrustedAdvisorResourceDetail </li> <li> TrustedAdvisorResourcesSummary </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> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest.WithCheckId(System.String)"> <summary> Sets the CheckId property </summary> <param name="checkId">The value to set for the CheckId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest.CheckId"> <summary> The unique identifier for the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest.Language"> <summary> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResponse"> <summary> Returns information about the DescribeTrustedAdvisorCheckResultResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResponse.DescribeTrustedAdvisorCheckResultResult"> <summary> Gets and sets the DescribeTrustedAdvisorCheckResultResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResult.WithResult(Amazon.AWSSupport.Model.TrustedAdvisorCheckResult)"> <summary> Sets the Result property </summary> <param name="result">The value to set for the Result property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResult.Result"> <summary> The detailed results of the Trusted Advisor check. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorChecks operation. <para>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 TrustedAdvisorCheckDescription for each check.</para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest.Language"> <summary> The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResponse"> <summary> Returns information about the DescribeTrustedAdvisorChecksResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResponse.DescribeTrustedAdvisorChecksResult"> <summary> Gets and sets the DescribeTrustedAdvisorChecksResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResult.WithChecks(Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription[])"> <summary> Adds elements to the Checks collection </summary> <param name="checks">The values to add to the Checks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResult.WithChecks(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription})"> <summary> Adds elements to the Checks collection </summary> <param name="checks">The values to add to the Checks collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResult.Checks"> <summary> Information about all available Trusted Advisor checks. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorCheckSummaries operation. <para>Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains an array of TrustedAdvisorCheckSummary objects.</para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest.WithCheckIds(System.String[])"> <summary> Adds elements to the CheckIds collection </summary> <param name="checkIds">The values to add to the CheckIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest.WithCheckIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CheckIds collection </summary> <param name="checkIds">The values to add to the CheckIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest.CheckIds"> <summary> The IDs of the Trusted Advisor checks. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResponse"> <summary> Returns information about the DescribeTrustedAdvisorCheckSummariesResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResponse.DescribeTrustedAdvisorCheckSummariesResult"> <summary> Gets and sets the DescribeTrustedAdvisorCheckSummariesResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResult.WithSummaries(Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary[])"> <summary> Adds elements to the Summaries collection </summary> <param name="summaries">The values to add to the Summaries collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResult.WithSummaries(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary})"> <summary> Adds elements to the Summaries collection </summary> <param name="summaries">The values to add to the Summaries collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResult.Summaries"> <summary> The summary information for the requested Trusted Advisor checks. </summary> </member> <member name="T:Amazon.AWSSupport.Model.InternalServerErrorException"> <summary> AmazonAWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.InternalServerErrorException.#ctor(System.String)"> <summary> Constructs a new InternalServerErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.AddCommunicationToCaseRequestMarshaller"> <summary> Add Communication To Case Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.AddCommunicationToCaseResponseUnmarshaller"> <summary> Response Unmarshaller for AddCommunicationToCase operation </summary> </member> <member name="T:Amazon.Runtime.Internal.Transform.JsonResponseUnmarshaller"> <summary> Class for unmarshalling JSON service responses. </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.AddCommunicationToCaseResultUnmarshaller"> <summary> AddCommunicationToCaseResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CaseDetailsUnmarshaller"> <summary> CaseDetailsUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CategoryUnmarshaller"> <summary> CategoryUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CommunicationUnmarshaller"> <summary> CommunicationUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CreateCaseRequestMarshaller"> <summary> Create Case Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CreateCaseResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCase operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CreateCaseResultUnmarshaller"> <summary> CreateCaseResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeCasesRequestMarshaller"> <summary> Describe Cases Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeCasesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCases operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeCasesResultUnmarshaller"> <summary> DescribeCasesResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeCommunicationsRequestMarshaller"> <summary> Describe Communications Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeCommunicationsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCommunications operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeCommunicationsResultUnmarshaller"> <summary> DescribeCommunicationsResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeServicesRequestMarshaller"> <summary> Describe Services Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeServicesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeServices operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeServicesResultUnmarshaller"> <summary> DescribeServicesResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeSeverityLevelsRequestMarshaller"> <summary> Describe Severity Levels Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeSeverityLevelsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSeverityLevels operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeSeverityLevelsResultUnmarshaller"> <summary> DescribeSeverityLevelsResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckRefreshStatusesRequestMarshaller"> <summary> Describe Trusted Advisor Check Refresh Statuses Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckRefreshStatusesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTrustedAdvisorCheckRefreshStatuses operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckRefreshStatusesResultUnmarshaller"> <summary> DescribeTrustedAdvisorCheckRefreshStatusesResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckResultRequestMarshaller"> <summary> Describe Trusted Advisor Check Result Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckResultResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTrustedAdvisorCheckResult operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckResultResultUnmarshaller"> <summary> DescribeTrustedAdvisorCheckResultResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorChecksRequestMarshaller"> <summary> Describe Trusted Advisor Checks Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorChecksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTrustedAdvisorChecks operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorChecksResultUnmarshaller"> <summary> DescribeTrustedAdvisorChecksResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckSummariesRequestMarshaller"> <summary> Describe Trusted Advisor Check Summaries Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckSummariesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTrustedAdvisorCheckSummaries operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeTrustedAdvisorCheckSummariesResultUnmarshaller"> <summary> DescribeTrustedAdvisorCheckSummariesResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.RecentCaseCommunicationsUnmarshaller"> <summary> RecentCaseCommunicationsUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.RefreshTrustedAdvisorCheckRequestMarshaller"> <summary> Refresh Trusted Advisor Check Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.RefreshTrustedAdvisorCheckResponseUnmarshaller"> <summary> Response Unmarshaller for RefreshTrustedAdvisorCheck operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.RefreshTrustedAdvisorCheckResultUnmarshaller"> <summary> RefreshTrustedAdvisorCheckResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.ResolveCaseRequestMarshaller"> <summary> Resolve Case Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.ResolveCaseResponseUnmarshaller"> <summary> Response Unmarshaller for ResolveCase operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.ResolveCaseResultUnmarshaller"> <summary> ResolveCaseResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.ServiceUnmarshaller"> <summary> ServiceUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.SeverityLevelUnmarshaller"> <summary> SeverityLevelUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCategorySpecificSummaryUnmarshaller"> <summary> TrustedAdvisorCategorySpecificSummaryUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckDescriptionUnmarshaller"> <summary> TrustedAdvisorCheckDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckRefreshStatusUnmarshaller"> <summary> TrustedAdvisorCheckRefreshStatusUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckResultUnmarshaller"> <summary> TrustedAdvisorCheckResultUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckSummaryUnmarshaller"> <summary> TrustedAdvisorCheckSummaryUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCostOptimizingSummaryUnmarshaller"> <summary> TrustedAdvisorCostOptimizingSummaryUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorResourceDetailUnmarshaller"> <summary> TrustedAdvisorResourceDetailUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorResourcesSummaryUnmarshaller"> <summary> TrustedAdvisorResourcesSummaryUnmarshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.RecentCaseCommunications"> <summary> <para>Contains the five most recent communications associated with the case.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.RecentCaseCommunications.WithCommunications(Amazon.AWSSupport.Model.Communication[])"> <summary> Adds elements to the Communications collection </summary> <param name="communications">The values to add to the Communications collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.RecentCaseCommunications.WithCommunications(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.Communication})"> <summary> Adds elements to the Communications collection </summary> <param name="communications">The values to add to the Communications collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.RecentCaseCommunications.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.RecentCaseCommunications.Communications"> <summary> The five most recent communications associated with the case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.RecentCaseCommunications.NextToken"> <summary> A resumption point for pagination. </summary> </member> <member name="T:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest"> <summary> Container for the parameters to the RefreshTrustedAdvisorCheck operation. <para>Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.</para> <para>The response contains a RefreshTrustedAdvisorCheckResult 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> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest.WithCheckId(System.String)"> <summary> Sets the CheckId property </summary> <param name="checkId">The value to set for the CheckId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest.CheckId"> <summary> The unique identifier for the Trusted Advisor check. </summary> </member> <member name="T:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResponse"> <summary> Returns information about the RefreshTrustedAdvisorCheckResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResponse.RefreshTrustedAdvisorCheckResult"> <summary> Gets and sets the RefreshTrustedAdvisorCheckResult property. The current refresh status of a Trusted Advisor check. </summary> </member> <member name="T:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResult"> <summary> <para>The current refresh status of a Trusted Advisor check.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResult.WithStatus(Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResult.Status"> <summary> The current refresh status for a check, including the amount of time until the check is eligible for refresh. </summary> </member> <member name="T:Amazon.AWSSupport.Model.ResolveCaseRequest"> <summary> Container for the parameters to the ResolveCase operation. <para>Takes a <c>CaseId</c> and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.</para> </summary> <seealso cref="M:Amazon.AWSSupport.AmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"/> </member> <member name="M:Amazon.AWSSupport.Model.ResolveCaseRequest.WithCaseId(System.String)"> <summary> Sets the CaseId property </summary> <param name="caseId">The value to set for the CaseId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseRequest.CaseId"> <summary> The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-2013-c4c1d2bf33c5cf47</i> </summary> </member> <member name="T:Amazon.AWSSupport.Model.ResolveCaseResponse"> <summary> Returns information about the ResolveCaseResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseResponse.ResolveCaseResult"> <summary> Gets and sets the ResolveCaseResult property. Contains the following objects or data if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.AWSSupport.Model.ResolveCaseResult"> <summary> <para>Contains the following objects or data if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.ResolveCaseResult.WithInitialCaseStatus(System.String)"> <summary> Sets the InitialCaseStatus property </summary> <param name="initialCaseStatus">The value to set for the InitialCaseStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.ResolveCaseResult.WithFinalCaseStatus(System.String)"> <summary> Sets the FinalCaseStatus property </summary> <param name="finalCaseStatus">The value to set for the FinalCaseStatus property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseResult.InitialCaseStatus"> <summary> The status of the case when the <a>ResolveCase</a> request was sent. </summary> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseResult.FinalCaseStatus"> <summary> The status of the case after the <a>ResolveCase</a> request was processed. </summary> </member> <member name="T:Amazon.AWSSupport.Model.Service"> <summary> <para>Represents an AWS Service returned by the DescribeServices action. </para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.Service.WithCode(System.String)"> <summary> Sets the Code property </summary> <param name="code">The value to set for the Code property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.Service.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.Service.WithCategories(Amazon.AWSSupport.Model.Category[])"> <summary> Adds elements to the Categories collection </summary> <param name="categories">The values to add to the Categories collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.Service.WithCategories(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.Category})"> <summary> Adds elements to the Categories collection </summary> <param name="categories">The values to add to the Categories collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.Service.Code"> <summary> The code for an AWS service returned by <a>DescribeServices</a> response. Has a corresponding name represented by Service.name. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Service.Name"> <summary> The friendly name for an AWS service. Has a corresponding code represented by Service.code. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Service.Categories"> <summary> A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call <a>CreateCase</a>. </summary> </member> <member name="T:Amazon.AWSSupport.Model.SeverityLevel"> <summary> <para>A code and name pair that represent a severity level that can be applied to a support case. </para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.SeverityLevel.WithCode(System.String)"> <summary> Sets the Code property </summary> <param name="code">The value to set for the Code property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.SeverityLevel.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.SeverityLevel.Code"> <summary> One of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in <c>SeverityLevel.name</c>. </summary> </member> <member name="P:Amazon.AWSSupport.Model.SeverityLevel.Name"> <summary> The name of the severity level that corresponds to the severity level code. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCategorySpecificSummary"> <summary> <para>The container for summary information that relates to the category of the Trusted Advisor check.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCategorySpecificSummary.WithCostOptimizing(Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary)"> <summary> Sets the CostOptimizing property </summary> <param name="costOptimizing">The value to set for the CostOptimizing property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCategorySpecificSummary.CostOptimizing"> <summary> The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription"> <summary> <para>The description and metadata for a Trusted Advisor check.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.WithCategory(System.String)"> <summary> Sets the Category property </summary> <param name="category">The value to set for the Category property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.WithMetadata(System.String[])"> <summary> Adds elements to the Metadata collection </summary> <param name="metadata">The values to add to the Metadata collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.WithMetadata(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Metadata collection </summary> <param name="metadata">The values to add to the Metadata collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Id"> <summary> The unique identifier for the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Name"> <summary> The display name for the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Description"> <summary> The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup). </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Category"> <summary> The category of the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Metadata"> <summary> The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the <b>Metadata</b> element of the <a>TrustedAdvisorResourceDetail</a> for the check. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus"> <summary> <para>The refresh status of a Trusted Advisor check. </para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.WithCheckId(System.String)"> <summary> Sets the CheckId property </summary> <param name="checkId">The value to set for the CheckId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.WithMillisUntilNextRefreshable(System.Int64)"> <summary> Sets the MillisUntilNextRefreshable property </summary> <param name="millisUntilNextRefreshable">The value to set for the MillisUntilNextRefreshable property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.CheckId"> <summary> The unique identifier for the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.Status"> <summary> The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned". </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.MillisUntilNextRefreshable"> <summary> The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckResponse"> <summary> Returns information about the TrustedAdvisorCheckResult response and response metadata. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResponse.TrustedAdvisorCheckResult"> <summary> Gets and sets the TrustedAdvisorCheckResult property. The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult"> <summary> <para>The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.WithCheckId(System.String)"> <summary> Sets the CheckId property </summary> <param name="checkId">The value to set for the CheckId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.WithTimestamp(System.String)"> <summary> Sets the Timestamp property </summary> <param name="timestamp">The value to set for the Timestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.WithResourcesSummary(Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary)"> <summary> Sets the ResourcesSummary property </summary> <param name="resourcesSummary">The value to set for the ResourcesSummary property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.WithCategorySpecificSummary(Amazon.AWSSupport.Model.TrustedAdvisorCategorySpecificSummary)"> <summary> Sets the CategorySpecificSummary property </summary> <param name="categorySpecificSummary">The value to set for the CategorySpecificSummary property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.WithFlaggedResources(Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail[])"> <summary> Adds elements to the FlaggedResources collection </summary> <param name="flaggedResources">The values to add to the FlaggedResources collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.WithFlaggedResources(System.Collections.Generic.IEnumerable{Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail})"> <summary> Adds elements to the FlaggedResources collection </summary> <param name="flaggedResources">The values to add to the FlaggedResources collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.CheckId"> <summary> The unique identifier for the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.Timestamp"> <summary> The time of the last refresh of the check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.Status"> <summary> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.ResourcesSummary"> <summary> Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.CategorySpecificSummary"> <summary> Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.FlaggedResources"> <summary> The details about each resource listed in the check result. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary"> <summary> <para>A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.WithCheckId(System.String)"> <summary> Sets the CheckId property </summary> <param name="checkId">The value to set for the CheckId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.WithTimestamp(System.String)"> <summary> Sets the Timestamp property </summary> <param name="timestamp">The value to set for the Timestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.WithHasFlaggedResources(System.Boolean)"> <summary> Sets the HasFlaggedResources property </summary> <param name="hasFlaggedResources">The value to set for the HasFlaggedResources property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.WithResourcesSummary(Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary)"> <summary> Sets the ResourcesSummary property </summary> <param name="resourcesSummary">The value to set for the ResourcesSummary property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.WithCategorySpecificSummary(Amazon.AWSSupport.Model.TrustedAdvisorCategorySpecificSummary)"> <summary> Sets the CategorySpecificSummary property </summary> <param name="categorySpecificSummary">The value to set for the CategorySpecificSummary property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.CheckId"> <summary> The unique identifier for the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.Timestamp"> <summary> The time of the last refresh of the check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.Status"> <summary> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.HasFlaggedResources"> <summary> Specifies whether the Trusted Advisor check has flagged resources. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.ResourcesSummary"> <summary> Details about AWS resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.CategorySpecificSummary"> <summary> Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary"> <summary> <para>The estimated cost savings that might be realized if the recommended actions are taken.</para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary.WithEstimatedMonthlySavings(System.Double)"> <summary> Sets the EstimatedMonthlySavings property </summary> <param name="estimatedMonthlySavings">The value to set for the EstimatedMonthlySavings property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary.WithEstimatedPercentMonthlySavings(System.Double)"> <summary> Sets the EstimatedPercentMonthlySavings property </summary> <param name="estimatedPercentMonthlySavings">The value to set for the EstimatedPercentMonthlySavings property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary.EstimatedMonthlySavings"> <summary> The estimated monthly savings that might be realized if the recommended actions are taken. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary.EstimatedPercentMonthlySavings"> <summary> The estimated percentage of savings that might be realized if the recommended actions are taken. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail"> <summary> <para>Contains information about a resource identified by a Trusted Advisor check. </para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.WithRegion(System.String)"> <summary> Sets the Region property </summary> <param name="region">The value to set for the Region property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.WithResourceId(System.String)"> <summary> Sets the ResourceId property </summary> <param name="resourceId">The value to set for the ResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.WithIsSuppressed(System.Boolean)"> <summary> Sets the IsSuppressed property </summary> <param name="isSuppressed">The value to set for the IsSuppressed property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.WithMetadata(System.String[])"> <summary> Adds elements to the Metadata collection </summary> <param name="metadata">The values to add to the Metadata collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.WithMetadata(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Metadata collection </summary> <param name="metadata">The values to add to the Metadata collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.Status"> <summary> The status code for the resource identified in the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.Region"> <summary> The AWS region in which the identified resource is located. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.ResourceId"> <summary> The unique identifier for the identified resource. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.IsSuppressed"> <summary> Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.Metadata"> <summary> Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the <a>TrustedAdvisorCheckDescription</a> object returned by the call to <a>DescribeTrustedAdvisorChecks</a>. </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary"> <summary> <para>Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries. </para> </summary> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.WithResourcesProcessed(System.Int64)"> <summary> Sets the ResourcesProcessed property </summary> <param name="resourcesProcessed">The value to set for the ResourcesProcessed property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.WithResourcesFlagged(System.Int64)"> <summary> Sets the ResourcesFlagged property </summary> <param name="resourcesFlagged">The value to set for the ResourcesFlagged property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.WithResourcesIgnored(System.Int64)"> <summary> Sets the ResourcesIgnored property </summary> <param name="resourcesIgnored">The value to set for the ResourcesIgnored property </param> <returns>this instance</returns> </member> <member name="M:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.WithResourcesSuppressed(System.Int64)"> <summary> Sets the ResourcesSuppressed property </summary> <param name="resourcesSuppressed">The value to set for the ResourcesSuppressed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.ResourcesProcessed"> <summary> The number of AWS resources that were analyzed by the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.ResourcesFlagged"> <summary> The number of AWS resources that were flagged (listed) by the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.ResourcesIgnored"> <summary> The number of AWS resources ignored by Trusted Advisor because information was unavailable. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.ResourcesSuppressed"> <summary> The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user. </summary> </member> <member name="T:Amazon.CloudFormation.AmazonCloudFormation"> <summary> Interface for accessing AmazonCloudFormation. 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://aws.amazon.com/documentation/" >http://aws.amazon.com/documentation/</a> .</para> </summary> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"> <summary> <para>Validates a specified template.</para> </summary> <param name="validateTemplateRequest">Container for the necessary parameters to execute the ValidateTemplate service method on AmazonCloudFormation.</param> <returns>The response from the ValidateTemplate service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidateTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"/> </summary> <param name="validateTemplateRequest">Container for the necessary parameters to execute the ValidateTemplate operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidateTemplate operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndValidateTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidateTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidateTemplate.</param> <returns>Returns a ValidateTemplateResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.ValidateTemplate"> <summary> <para>Validates a specified template.</para> </summary> <returns>The response from the ValidateTemplate service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"> <summary> <para>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</para> </summary> <param name="describeStacksRequest">Container for the necessary parameters to execute the DescribeStacks service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginDescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"/> </summary> <param name="describeStacksRequest">Container for the necessary parameters to execute the DescribeStacks operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStacks operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndDescribeStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStacks.</param> <returns>Returns a DescribeStacksResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStacks"> <summary> <para>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</para> </summary> <returns>The response from the DescribeStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"> <summary> <para>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</para> <para>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.</para> <para><b>NOTE:</b> If the template does not exist, a ValidationError is returned. </para> </summary> <param name="getTemplateRequest">Container for the necessary parameters to execute the GetTemplate service method on AmazonCloudFormation.</param> <returns>The response from the GetTemplate service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginGetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"/> </summary> <param name="getTemplateRequest">Container for the necessary parameters to execute the GetTemplate operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTemplate operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndGetTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTemplate.</param> <returns>Returns a GetTemplateResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"> <summary> <para>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.</para> </summary> <param name="getStackPolicyRequest">Container for the necessary parameters to execute the GetStackPolicy service method on AmazonCloudFormation.</param> <returns>The response from the GetStackPolicy service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginGetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"/> </summary> <param name="getStackPolicyRequest">Container for the necessary parameters to execute the GetStackPolicy operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStackPolicy operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndGetStackPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStackPolicy.</param> <returns>Returns a GetStackPolicyResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"> <summary> <para>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).</para> </summary> <param name="listStacksRequest">Container for the necessary parameters to execute the ListStacks service method on AmazonCloudFormation.</param> <returns>The response from the ListStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginListStacks(Amazon.CloudFormation.Model.ListStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"/> </summary> <param name="listStacksRequest">Container for the necessary parameters to execute the ListStacks operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStacks operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndListStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStacks.</param> <returns>Returns a ListStacksResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.ListStacks"> <summary> <para>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).</para> </summary> <returns>The response from the ListStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"> <summary> <para>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 DescribeStacks API.</para> <para><b>NOTE:</b> Currently, the limit for stacks is 20 stacks per account per region. </para> </summary> <param name="createStackRequest">Container for the necessary parameters to execute the CreateStack service method on AmazonCloudFormation.</param> <returns>The response from the CreateStack service method, as returned by AmazonCloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.AlreadyExistsException"/> <exception cref="T:Amazon.CloudFormation.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"/> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginCreateStack(Amazon.CloudFormation.Model.CreateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"/> </summary> <param name="createStackRequest">Container for the necessary parameters to execute the CreateStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndCreateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStack.</param> <returns>Returns a CreateStackResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"> <summary> <para>Sets a stack policy for a specified stack.</para> </summary> <param name="setStackPolicyRequest">Container for the necessary parameters to execute the SetStackPolicy service method on AmazonCloudFormation.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginSetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"/> </summary> <param name="setStackPolicyRequest">Container for the necessary parameters to execute the SetStackPolicy operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndSetStackPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStackPolicy.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"> <summary> <para>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.</para> </summary> <param name="estimateTemplateCostRequest">Container for the necessary parameters to execute the EstimateTemplateCost service method on AmazonCloudFormation.</param> <returns>The response from the EstimateTemplateCost service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginEstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EstimateTemplateCost operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"/> </summary> <param name="estimateTemplateCostRequest">Container for the necessary parameters to execute the EstimateTemplateCost operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEstimateTemplateCost operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndEstimateTemplateCost(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EstimateTemplateCost operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEstimateTemplateCost.</param> <returns>Returns a EstimateTemplateCostResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"> <summary> <para>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.</para> <para><b>NOTE:</b>Events are returned, even if the stack never existed or has been successfully deleted.</para> </summary> <param name="describeStackEventsRequest">Container for the necessary parameters to execute the DescribeStackEvents service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStackEvents service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginDescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackEvents operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"/> </summary> <param name="describeStackEventsRequest">Container for the necessary parameters to execute the DescribeStackEvents operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStackEvents operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndDescribeStackEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackEvents operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackEvents.</param> <returns>Returns a DescribeStackEventsResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"> <summary> <para>Returns a description of the specified resource in the specified stack.</para> <para>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</para> </summary> <param name="describeStackResourceRequest">Container for the necessary parameters to execute the DescribeStackResource service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStackResource service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginDescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResource operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"/> </summary> <param name="describeStackResourceRequest">Container for the necessary parameters to execute the DescribeStackResource operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStackResource operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndDescribeStackResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackResource operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResource.</param> <returns>Returns a DescribeStackResourceResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"> <summary> <para>Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.</para> <para><b>NOTE:</b>Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.</para> </summary> <param name="cancelUpdateStackRequest">Container for the necessary parameters to execute the CancelUpdateStack service method on AmazonCloudFormation.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginCancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelUpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"/> </summary> <param name="cancelUpdateStackRequest">Container for the necessary parameters to execute the CancelUpdateStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndCancelUpdateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelUpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelUpdateStack.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"> <summary> <para>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 DescribeStacks action.</para> <para> <b>Note: </b> You cannot update <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html">AWS::S3::Bucket</a> resources, for example, to add or modify tags.</para> <para>To get a copy of the template for an existing stack, you can use the GetTemplate action.</para> <para>Tags that were associated with this stack during creation time will still be associated with the stack after an <c>UpdateStack</c> operation.</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="updateStackRequest">Container for the necessary parameters to execute the UpdateStack service method on AmazonCloudFormation.</param> <returns>The response from the UpdateStack service method, as returned by AmazonCloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"/> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginUpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"/> </summary> <param name="updateStackRequest">Container for the necessary parameters to execute the UpdateStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndUpdateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStack.</param> <returns>Returns a UpdateStackResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"> <summary> <para>Returns AWS resource descriptions for running and deleted stacks. If <c>StackName</c> is specified, all the associated resources that are part of the stack are returned. If <c>PhysicalResourceId</c> is specified, the associated resources of the stack that the resource belongs to are returned.</para> <para><b>NOTE:</b>Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.</para> <para>For deleted stacks, <c>DescribeStackResources</c> returns resource information for up to 90 days after the stack has been deleted.</para> <para>You must specify either <c>StackName</c> or <c>PhysicalResourceId</c> , but not both. In addition, you can specify <c>LogicalResourceId</c> to filter the returned result. For more information about resources, the <c>LogicalResourceId</c> and <c>PhysicalResourceId</c> , go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide" >AWS CloudFormation User Guide</a> .</para> <para><b>NOTE:</b>A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.</para> </summary> <param name="describeStackResourcesRequest">Container for the necessary parameters to execute the DescribeStackResources service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStackResources service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginDescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"/> </summary> <param name="describeStackResourcesRequest">Container for the necessary parameters to execute the DescribeStackResources operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStackResources operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndDescribeStackResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResources.</param> <returns>Returns a DescribeStackResourcesResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"> <summary> <para>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.</para> </summary> <param name="deleteStackRequest">Container for the necessary parameters to execute the DeleteStack service method on AmazonCloudFormation.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginDeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"/> </summary> <param name="deleteStackRequest">Container for the necessary parameters to execute the DeleteStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndDeleteStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteStack.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"> <summary> <para>Returns descriptions of all resources of the specified stack.</para> <para>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</para> </summary> <param name="listStackResourcesRequest">Container for the necessary parameters to execute the ListStackResources service method on AmazonCloudFormation.</param> <returns>The response from the ListStackResources service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.BeginListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"/> </summary> <param name="listStackResourcesRequest">Container for the necessary parameters to execute the ListStackResources operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStackResources operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormation.EndListStackResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStackResources.</param> <returns>Returns a ListStackResourcesResult from AmazonCloudFormation.</returns> </member> <member name="T:Amazon.CloudFormation.AmazonCloudFormationClient"> <summary> Implementation for accessing AmazonCloudFormation. 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://aws.amazon.com/documentation/" >http://aws.amazon.com/documentation/</a> .</para> </summary> <summary> Implementation for accessing AmazonCloudFormation. 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://aws.amazon.com/documentation/" >http://aws.amazon.com/documentation/</a> .</para> </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudFormation 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"> <summary> <para>Validates a specified template.</para> </summary> <param name="validateTemplateRequest">Container for the necessary parameters to execute the ValidateTemplate service method on AmazonCloudFormation.</param> <returns>The response from the ValidateTemplate service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidateTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"/> </summary> <param name="validateTemplateRequest">Container for the necessary parameters to execute the ValidateTemplate operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidateTemplate operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndValidateTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidateTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidateTemplate.</param> <returns>Returns a ValidateTemplateResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ValidateTemplate"> <summary> <para>Validates a specified template.</para> </summary> <returns>The response from the ValidateTemplate service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"> <summary> <para>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</para> </summary> <param name="describeStacksRequest">Container for the necessary parameters to execute the DescribeStacks service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"/> </summary> <param name="describeStacksRequest">Container for the necessary parameters to execute the DescribeStacks operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStacks operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndDescribeStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStacks.</param> <returns>Returns a DescribeStacksResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStacks"> <summary> <para>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</para> </summary> <returns>The response from the DescribeStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"> <summary> <para>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</para> <para>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.</para> <para><b>NOTE:</b> If the template does not exist, a ValidationError is returned. </para> </summary> <param name="getTemplateRequest">Container for the necessary parameters to execute the GetTemplate service method on AmazonCloudFormation.</param> <returns>The response from the GetTemplate service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginGetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"/> </summary> <param name="getTemplateRequest">Container for the necessary parameters to execute the GetTemplate operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTemplate operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndGetTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTemplate operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTemplate.</param> <returns>Returns a GetTemplateResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"> <summary> <para>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.</para> </summary> <param name="getStackPolicyRequest">Container for the necessary parameters to execute the GetStackPolicy service method on AmazonCloudFormation.</param> <returns>The response from the GetStackPolicy service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginGetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"/> </summary> <param name="getStackPolicyRequest">Container for the necessary parameters to execute the GetStackPolicy operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStackPolicy operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndGetStackPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStackPolicy.</param> <returns>Returns a GetStackPolicyResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"> <summary> <para>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).</para> </summary> <param name="listStacksRequest">Container for the necessary parameters to execute the ListStacks service method on AmazonCloudFormation.</param> <returns>The response from the ListStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginListStacks(Amazon.CloudFormation.Model.ListStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"/> </summary> <param name="listStacksRequest">Container for the necessary parameters to execute the ListStacks operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStacks operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndListStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStacks operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStacks.</param> <returns>Returns a ListStacksResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStacks"> <summary> <para>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).</para> </summary> <returns>The response from the ListStacks service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"> <summary> <para>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 DescribeStacks API.</para> <para><b>NOTE:</b> Currently, the limit for stacks is 20 stacks per account per region. </para> </summary> <param name="createStackRequest">Container for the necessary parameters to execute the CreateStack service method on AmazonCloudFormation.</param> <returns>The response from the CreateStack service method, as returned by AmazonCloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.AlreadyExistsException"/> <exception cref="T:Amazon.CloudFormation.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"/> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginCreateStack(Amazon.CloudFormation.Model.CreateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"/> </summary> <param name="createStackRequest">Container for the necessary parameters to execute the CreateStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndCreateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStack.</param> <returns>Returns a CreateStackResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"> <summary> <para>Sets a stack policy for a specified stack.</para> </summary> <param name="setStackPolicyRequest">Container for the necessary parameters to execute the SetStackPolicy service method on AmazonCloudFormation.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginSetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"/> </summary> <param name="setStackPolicyRequest">Container for the necessary parameters to execute the SetStackPolicy operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndSetStackPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStackPolicy operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStackPolicy.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"> <summary> <para>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.</para> </summary> <param name="estimateTemplateCostRequest">Container for the necessary parameters to execute the EstimateTemplateCost service method on AmazonCloudFormation.</param> <returns>The response from the EstimateTemplateCost service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginEstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EstimateTemplateCost operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"/> </summary> <param name="estimateTemplateCostRequest">Container for the necessary parameters to execute the EstimateTemplateCost operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEstimateTemplateCost operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndEstimateTemplateCost(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EstimateTemplateCost operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEstimateTemplateCost.</param> <returns>Returns a EstimateTemplateCostResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"> <summary> <para>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.</para> <para><b>NOTE:</b>Events are returned, even if the stack never existed or has been successfully deleted.</para> </summary> <param name="describeStackEventsRequest">Container for the necessary parameters to execute the DescribeStackEvents service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStackEvents service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackEvents operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"/> </summary> <param name="describeStackEventsRequest">Container for the necessary parameters to execute the DescribeStackEvents operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStackEvents operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndDescribeStackEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackEvents operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackEvents.</param> <returns>Returns a DescribeStackEventsResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"> <summary> <para>Returns a description of the specified resource in the specified stack.</para> <para>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</para> </summary> <param name="describeStackResourceRequest">Container for the necessary parameters to execute the DescribeStackResource service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStackResource service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResource operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"/> </summary> <param name="describeStackResourceRequest">Container for the necessary parameters to execute the DescribeStackResource operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStackResource operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndDescribeStackResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackResource operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResource.</param> <returns>Returns a DescribeStackResourceResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"> <summary> <para>Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.</para> <para><b>NOTE:</b>Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.</para> </summary> <param name="cancelUpdateStackRequest">Container for the necessary parameters to execute the CancelUpdateStack service method on AmazonCloudFormation.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginCancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelUpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"/> </summary> <param name="cancelUpdateStackRequest">Container for the necessary parameters to execute the CancelUpdateStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndCancelUpdateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelUpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelUpdateStack.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"> <summary> <para>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 DescribeStacks action.</para> <para> <b>Note: </b> You cannot update <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html">AWS::S3::Bucket</a> resources, for example, to add or modify tags.</para> <para>To get a copy of the template for an existing stack, you can use the GetTemplate action.</para> <para>Tags that were associated with this stack during creation time will still be associated with the stack after an <c>UpdateStack</c> operation.</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="updateStackRequest">Container for the necessary parameters to execute the UpdateStack service method on AmazonCloudFormation.</param> <returns>The response from the UpdateStack service method, as returned by AmazonCloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"/> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginUpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"/> </summary> <param name="updateStackRequest">Container for the necessary parameters to execute the UpdateStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndUpdateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStack.</param> <returns>Returns a UpdateStackResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"> <summary> <para>Returns AWS resource descriptions for running and deleted stacks. If <c>StackName</c> is specified, all the associated resources that are part of the stack are returned. If <c>PhysicalResourceId</c> is specified, the associated resources of the stack that the resource belongs to are returned.</para> <para><b>NOTE:</b>Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.</para> <para>For deleted stacks, <c>DescribeStackResources</c> returns resource information for up to 90 days after the stack has been deleted.</para> <para>You must specify either <c>StackName</c> or <c>PhysicalResourceId</c> , but not both. In addition, you can specify <c>LogicalResourceId</c> to filter the returned result. For more information about resources, the <c>LogicalResourceId</c> and <c>PhysicalResourceId</c> , go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide" >AWS CloudFormation User Guide</a> .</para> <para><b>NOTE:</b>A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.</para> </summary> <param name="describeStackResourcesRequest">Container for the necessary parameters to execute the DescribeStackResources service method on AmazonCloudFormation.</param> <returns>The response from the DescribeStackResources service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"/> </summary> <param name="describeStackResourcesRequest">Container for the necessary parameters to execute the DescribeStackResources operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStackResources operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndDescribeStackResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResources.</param> <returns>Returns a DescribeStackResourcesResult from AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"> <summary> <para>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.</para> </summary> <param name="deleteStackRequest">Container for the necessary parameters to execute the DeleteStack service method on AmazonCloudFormation.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"/> </summary> <param name="deleteStackRequest">Container for the necessary parameters to execute the DeleteStack operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndDeleteStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteStack operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteStack.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"> <summary> <para>Returns descriptions of all resources of the specified stack.</para> <para>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</para> </summary> <param name="listStackResourcesRequest">Container for the necessary parameters to execute the ListStackResources service method on AmazonCloudFormation.</param> <returns>The response from the ListStackResources service method, as returned by AmazonCloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"/> </summary> <param name="listStackResourcesRequest">Container for the necessary parameters to execute the ListStackResources operation on AmazonCloudFormation.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStackResources operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndListStackResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStackResources operation. <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStackResources.</param> <returns>Returns a ListStackResourcesResult from AmazonCloudFormation.</returns> </member> <member name="T:Amazon.CloudFormation.AmazonCloudFormationConfig"> <summary> Configuration for accessing AWS CloudFormation service </summary> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudFormation.AmazonCloudFormationConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudFormation.AmazonCloudFormationConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CloudFormation.Model.AlreadyExistsException"> <summary> AmazonCloudFormation exception </summary> </member> <member name="M:Amazon.CloudFormation.Model.AlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new AlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFormation.Model.CancelUpdateStackRequest"> <summary> Container for the parameters to the CancelUpdateStack operation. <para>Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.</para> <para><b>NOTE:</b>Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.CancelUpdateStackRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.CancelUpdateStackRequest.StackName"> <summary> The name or the unique identifier associated with the stack. </summary> </member> <member name="T:Amazon.CloudFormation.Model.CancelUpdateStackResponse"> <summary> Returns information about the CancelUpdateStack response metadata. The CancelUpdateStack operation has a void result type. </summary> </member> <member name="T:Amazon.CloudFormation.Model.CreateStackRequest"> <summary> Container for the parameters to the CreateStack operation. <para>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 DescribeStacks API.</para> <para><b>NOTE:</b> Currently, the limit for stacks is 20 stacks per account per region. </para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithTemplateBody(System.String)"> <summary> Sets the TemplateBody property </summary> <param name="templateBody">The value to set for the TemplateBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithTemplateURL(System.String)"> <summary> Sets the TemplateURL property </summary> <param name="templateURL">The value to set for the TemplateURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithParameters(Amazon.CloudFormation.Model.Parameter[])"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithParameters(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Parameter})"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithDisableRollback(System.Boolean)"> <summary> Sets the DisableRollback property </summary> <param name="disableRollback">The value to set for the DisableRollback property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithTimeoutInMinutes(System.Int32)"> <summary> Sets the TimeoutInMinutes property </summary> <param name="timeoutInMinutes">The value to set for the TimeoutInMinutes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithNotificationARNs(System.String[])"> <summary> Adds elements to the NotificationARNs collection </summary> <param name="notificationARNs">The values to add to the NotificationARNs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithNotificationARNs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the NotificationARNs collection </summary> <param name="notificationARNs">The values to add to the NotificationARNs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithCapabilities(System.String[])"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithCapabilities(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithOnFailure(System.String)"> <summary> Sets the OnFailure property </summary> <param name="onFailure">The value to set for the OnFailure property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithStackPolicyBody(System.String)"> <summary> Sets the StackPolicyBody property </summary> <param name="stackPolicyBody">The value to set for the StackPolicyBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithStackPolicyURL(System.String)"> <summary> Sets the StackPolicyURL property </summary> <param name="stackPolicyURL">The value to set for the StackPolicyURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithTags(Amazon.CloudFormation.Model.Tag[])"> <summary> Adds elements to the Tags collection </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackRequest.WithTags(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Tag})"> <summary> Adds elements to the Tags collection </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.StackName"> <summary> The name associated with the stack. The name must be unique within your AWS account. <note>Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.</note> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.TemplateBody"> <summary> Structure containing the template body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.) Conditional: You must pass <c>TemplateBody</c> or <c>TemplateURL</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.TemplateURL"> <summary> Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide. Conditional: You must pass <c>TemplateURL</c> or <c>TemplateBody</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.Parameters"> <summary> A list of <c>Parameter</c> structures that specify input parameters for the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.DisableRollback"> <summary> Set to <c>true</c> to disable rollback of the stack if stack creation failed. You can specify either <c>DisableRollback</c> or <c>OnFailure</c>, but not both. Default: <c>false</c> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.TimeoutInMinutes"> <summary> The amount of time that can pass before the stack status becomes CREATE_FAILED; if <c>DisableRollback</c> is not set or is set to <c>false</c>, the stack will be rolled back. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.NotificationARNs"> <summary> The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the <a href="http://console.aws.amazon.com/sns">SNS console</a> or your Command Line Interface (CLI). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.Capabilities"> <summary> The list of capabilities that you want to allow in the stack. If your template contains certain resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. The following resources require you to specify the capabilities parameter: <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html">AWS::CloudFormation::Stack</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html">AWS::IAM::AccessKey</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">AWS::IAM::Group</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html">AWS::IAM::Policy</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html">AWS::IAM::Role</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html">AWS::IAM::User</a>, and <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>. </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.OnFailure"> <summary> Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either <c>OnFailure</c> or <c>DisableRollback</c>, but not both. Default: <c>ROLLBACK</c> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>DO_NOTHING, ROLLBACK, DELETE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.StackPolicyBody"> <summary> Structure containing the stack policy body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide.) If you pass <c>StackPolicyBody</c> and <c>StackPolicyURL</c>, only <c>StackPolicyBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 16384</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.StackPolicyURL"> <summary> Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. If you pass <c>StackPolicyBody</c> and <c>StackPolicyURL</c>, only <c>StackPolicyBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1350</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.Tags"> <summary> A set of user-defined <c>Tags</c> to associate with this stack, represented by key/value pairs. Tags defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified. </summary> </member> <member name="T:Amazon.CloudFormation.Model.CreateStackResponse"> <summary> Returns information about the CreateStackResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackResponse.CreateStackResult"> <summary> Gets and sets the CreateStackResult property. The output for a CreateStack action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.CreateStackResult"> <summary> <para>The output for a CreateStack action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.CreateStackResult.WithStackId(System.String)"> <summary> Sets the StackId property </summary> <param name="stackId">The value to set for the StackId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackResult.StackId"> <summary> Unique identifier of the stack. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DeleteStackRequest"> <summary> Container for the parameters to the DeleteStack operation. <para>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.DeleteStackRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DeleteStackRequest.StackName"> <summary> The name or the unique identifier associated with the stack. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DeleteStackResponse"> <summary> Returns information about the DeleteStack response metadata. The DeleteStack operation has a void result type. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackEventsRequest"> <summary> Container for the parameters to the DescribeStackEvents operation. <para>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.</para> <para><b>NOTE:</b>Events are returned, even if the stack never existed or has been successfully deleted.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackEventsRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackEventsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsRequest.StackName"> <summary> The name or the unique identifier associated with the stack. Default: There is no default value. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsRequest.NextToken"> <summary> String that identifies the start of the next list of events, if there is one. Default: There is no default value. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackEventsResponse"> <summary> Returns information about the DescribeStackEventsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsResponse.DescribeStackEventsResult"> <summary> Gets and sets the DescribeStackEventsResult property. The output for a DescribeStackEvents action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackEventsResult"> <summary> <para>The output for a DescribeStackEvents action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackEventsResult.WithStackEvents(Amazon.CloudFormation.Model.StackEvent[])"> <summary> Adds elements to the StackEvents collection </summary> <param name="stackEvents">The values to add to the StackEvents collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackEventsResult.WithStackEvents(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.StackEvent})"> <summary> Adds elements to the StackEvents collection </summary> <param name="stackEvents">The values to add to the StackEvents collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackEventsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsResult.StackEvents"> <summary> A list of <c>StackEvents</c> structures. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsResult.NextToken"> <summary> String that identifies the start of the next list of events, if there is one. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourceRequest"> <summary> Container for the parameters to the DescribeStackResource operation. <para>Returns a description of the specified resource in the specified stack.</para> <para>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourceRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourceRequest.WithLogicalResourceId(System.String)"> <summary> Sets the LogicalResourceId property </summary> <param name="logicalResourceId">The value to set for the LogicalResourceId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceRequest.StackName"> <summary> The name or the unique identifier associated with the stack. Default: There is no default value. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceRequest.LogicalResourceId"> <summary> The logical name of the resource as specified in the template. Default: There is no default value. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourceResponse"> <summary> Returns information about the DescribeStackResourceResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceResponse.DescribeStackResourceResult"> <summary> Gets and sets the DescribeStackResourceResult property. The output for a DescribeStackResource action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourceResult"> <summary> <para>The output for a DescribeStackResource action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourceResult.WithStackResourceDetail(Amazon.CloudFormation.Model.StackResourceDetail)"> <summary> Sets the StackResourceDetail property </summary> <param name="stackResourceDetail">The value to set for the StackResourceDetail property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceResult.StackResourceDetail"> <summary> A <c>StackResourceDetail</c> structure containing the description of the specified resource in the specified stack. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourcesRequest"> <summary> Container for the parameters to the DescribeStackResources operation. <para>Returns AWS resource descriptions for running and deleted stacks. If <c>StackName</c> is specified, all the associated resources that are part of the stack are returned. If <c>PhysicalResourceId</c> is specified, the associated resources of the stack that the resource belongs to are returned.</para> <para><b>NOTE:</b>Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.</para> <para>For deleted stacks, <c>DescribeStackResources</c> returns resource information for up to 90 days after the stack has been deleted.</para> <para>You must specify either <c>StackName</c> or <c>PhysicalResourceId</c> , but not both. In addition, you can specify <c>LogicalResourceId</c> to filter the returned result. For more information about resources, the <c>LogicalResourceId</c> and <c>PhysicalResourceId</c> , go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a> .</para> <para><b>NOTE:</b>A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.WithLogicalResourceId(System.String)"> <summary> Sets the LogicalResourceId property </summary> <param name="logicalResourceId">The value to set for the LogicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.WithPhysicalResourceId(System.String)"> <summary> Sets the PhysicalResourceId property </summary> <param name="physicalResourceId">The value to set for the PhysicalResourceId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.StackName"> <summary> The name or the unique identifier associated with the stack. Required: Conditional. If you do not specify <c>StackName</c>, you must specify <c>PhysicalResourceId</c>. Default: There is no default value. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.LogicalResourceId"> <summary> The logical name of the resource as specified in the template. Default: There is no default value. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.PhysicalResourceId"> <summary> The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. For example, for an Amazon Elastic Compute Cloud (EC2) instance, <c>PhysicalResourceId</c> corresponds to the <c>InstanceId</c>. You can pass the EC2 <c>InstanceId</c> to <c>DescribeStackResources</c> to find which stack the instance belongs to and what other resources are part of the stack. Required: Conditional. If you do not specify <c>PhysicalResourceId</c>, you must specify <c>StackName</c>. Default: There is no default value. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourcesResponse"> <summary> Returns information about the DescribeStackResourcesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesResponse.DescribeStackResourcesResult"> <summary> Gets and sets the DescribeStackResourcesResult property. The output for a DescribeStackResources action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourcesResult"> <summary> <para>The output for a DescribeStackResources action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourcesResult.WithStackResources(Amazon.CloudFormation.Model.StackResource[])"> <summary> Adds elements to the StackResources collection </summary> <param name="stackResources">The values to add to the StackResources collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStackResourcesResult.WithStackResources(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.StackResource})"> <summary> Adds elements to the StackResources collection </summary> <param name="stackResources">The values to add to the StackResources collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesResult.StackResources"> <summary> A list of <c>StackResource</c> structures. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStacksRequest"> <summary> Container for the parameters to the DescribeStacks operation. <para>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStacksRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStacksRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksRequest.StackName"> <summary> The name or the unique identifier associated with the stack. Default: There is no default value. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksRequest.NextToken"> <summary> String that identifies the start of the next list of stacks, if there is one. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStacksResponse"> <summary> Returns information about the DescribeStacksResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksResponse.DescribeStacksResult"> <summary> Gets and sets the DescribeStacksResult property. The output for a DescribeStacks action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStacksResult"> <summary> <para>The output for a DescribeStacks action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStacksResult.WithStacks(Amazon.CloudFormation.Model.Stack[])"> <summary> Adds elements to the Stacks collection </summary> <param name="stacks">The values to add to the Stacks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStacksResult.WithStacks(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Stack})"> <summary> Adds elements to the Stacks collection </summary> <param name="stacks">The values to add to the Stacks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.DescribeStacksResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksResult.Stacks"> <summary> A list of stack structures. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksResult.NextToken"> <summary> String that identifies the start of the next list of stacks, if there is one. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.EstimateTemplateCostRequest"> <summary> Container for the parameters to the EstimateTemplateCost operation. <para>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.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.WithTemplateBody(System.String)"> <summary> Sets the TemplateBody property </summary> <param name="templateBody">The value to set for the TemplateBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.WithTemplateURL(System.String)"> <summary> Sets the TemplateURL property </summary> <param name="templateURL">The value to set for the TemplateURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.WithParameters(Amazon.CloudFormation.Model.Parameter[])"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.WithParameters(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Parameter})"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.TemplateBody"> <summary> Structure containing the template body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.) Conditional: You must pass <c>TemplateBody</c> or <c>TemplateURL</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.TemplateURL"> <summary> Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide. Conditional: You must pass <c>TemplateURL</c> or <c>TemplateBody</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.Parameters"> <summary> A list of <c>Parameter</c> structures that specify input parameters. </summary> </member> <member name="T:Amazon.CloudFormation.Model.EstimateTemplateCostResponse"> <summary> Returns information about the EstimateTemplateCostResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostResponse.EstimateTemplateCostResult"> <summary> Gets and sets the EstimateTemplateCostResult property. The output for a EstimateTemplateCost action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.EstimateTemplateCostResult"> <summary> <para>The output for a EstimateTemplateCost action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.EstimateTemplateCostResult.WithUrl(System.String)"> <summary> Sets the Url property </summary> <param name="url">The value to set for the Url property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostResult.Url"> <summary> An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetStackPolicyRequest"> <summary> Container for the parameters to the GetStackPolicy operation. <para>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.GetStackPolicyRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.GetStackPolicyRequest.StackName"> <summary> The name or stack ID that is associated with the stack whose policy you want to get. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetStackPolicyResponse"> <summary> Returns information about the GetStackPolicyResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetStackPolicyResponse.GetStackPolicyResult"> <summary> Gets and sets the GetStackPolicyResult property. The output for the GetStackPolicy action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetStackPolicyResult"> <summary> <para>The output for the GetStackPolicy action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.GetStackPolicyResult.WithStackPolicyBody(System.String)"> <summary> Sets the StackPolicyBody property </summary> <param name="stackPolicyBody">The value to set for the StackPolicyBody property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.GetStackPolicyResult.StackPolicyBody"> <summary> Structure containing the stack policy body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide.) <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 16384</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateRequest"> <summary> Container for the parameters to the GetTemplate operation. <para>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</para> <para>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.</para> <para><b>NOTE:</b> If the template does not exist, a ValidationError is returned. </para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.GetTemplateRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateRequest.StackName"> <summary> The name or the unique identifier associated with the stack, which are not always interchangeable: <ul> <li>Running stacks: You can specify either the stack's name or its unique stack ID.</li> <li>Deleted stacks: You must specify the unique stack ID.</li> </ul> Default: There is no default value. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateResponse"> <summary> Returns information about the GetTemplateResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateResponse.GetTemplateResult"> <summary> Gets and sets the GetTemplateResult property. The output for GetTemplate action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateResult"> <summary> <para>The output for GetTemplate action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.GetTemplateResult.WithTemplateBody(System.String)"> <summary> Sets the TemplateBody property </summary> <param name="templateBody">The value to set for the TemplateBody property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateResult.TemplateBody"> <summary> Structure containing the template body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.) <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> <summary> AmazonCloudFormation exception </summary> </member> <member name="M:Amazon.CloudFormation.Model.InsufficientCapabilitiesException.#ctor(System.String)"> <summary> Constructs a new InsufficientCapabilitiesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.CancelUpdateStackRequestMarshaller"> <summary> Cancel Update Stack Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.CancelUpdateStackResponseUnmarshaller"> <summary> Response Unmarshaller for CancelUpdateStack operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.CreateStackRequestMarshaller"> <summary> Create Stack Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.CreateStackResponseUnmarshaller"> <summary> Response Unmarshaller for CreateStack operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.CreateStackResultUnmarshaller"> <summary> CreateStackResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DeleteStackRequestMarshaller"> <summary> Delete Stack Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DeleteStackResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteStack operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackEventsRequestMarshaller"> <summary> Describe Stack Events Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackEventsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStackEvents operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackEventsResultUnmarshaller"> <summary> DescribeStackEventsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackResourceRequestMarshaller"> <summary> Describe Stack Resource Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackResourceResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStackResource operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackResourceResultUnmarshaller"> <summary> DescribeStackResourceResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackResourcesRequestMarshaller"> <summary> Describe Stack Resources Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackResourcesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStackResources operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackResourcesResultUnmarshaller"> <summary> DescribeStackResourcesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStacksRequestMarshaller"> <summary> Describe Stacks Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStacksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStacks operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStacksResultUnmarshaller"> <summary> DescribeStacksResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.EstimateTemplateCostRequestMarshaller"> <summary> Estimate Template Cost Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.EstimateTemplateCostResponseUnmarshaller"> <summary> Response Unmarshaller for EstimateTemplateCost operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.EstimateTemplateCostResultUnmarshaller"> <summary> EstimateTemplateCostResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.GetStackPolicyRequestMarshaller"> <summary> Get Stack Policy Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.GetStackPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for GetStackPolicy operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.GetStackPolicyResultUnmarshaller"> <summary> GetStackPolicyResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.GetTemplateRequestMarshaller"> <summary> Get Template Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.GetTemplateResponseUnmarshaller"> <summary> Response Unmarshaller for GetTemplate operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.GetTemplateResultUnmarshaller"> <summary> GetTemplateResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ListStackResourcesRequestMarshaller"> <summary> List Stack Resources Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ListStackResourcesResponseUnmarshaller"> <summary> Response Unmarshaller for ListStackResources operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ListStackResourcesResultUnmarshaller"> <summary> ListStackResourcesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ListStacksRequestMarshaller"> <summary> List Stacks Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ListStacksResponseUnmarshaller"> <summary> Response Unmarshaller for ListStacks operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ListStacksResultUnmarshaller"> <summary> ListStacksResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.OutputUnmarshaller"> <summary> Output Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ParameterUnmarshaller"> <summary> Parameter Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.SetStackPolicyRequestMarshaller"> <summary> Set Stack Policy Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.SetStackPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for SetStackPolicy operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackEventUnmarshaller"> <summary> StackEvent Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackResourceDetailUnmarshaller"> <summary> StackResourceDetail Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackResourceSummaryUnmarshaller"> <summary> StackResourceSummary Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackResourceUnmarshaller"> <summary> StackResource Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackSummaryUnmarshaller"> <summary> StackSummary Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackUnmarshaller"> <summary> Stack Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.TagUnmarshaller"> <summary> Tag Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.TemplateParameterUnmarshaller"> <summary> TemplateParameter Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.UpdateStackRequestMarshaller"> <summary> Update Stack Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.UpdateStackResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateStack operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.UpdateStackResultUnmarshaller"> <summary> UpdateStackResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ValidateTemplateRequestMarshaller"> <summary> Validate Template Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ValidateTemplateResponseUnmarshaller"> <summary> Response Unmarshaller for ValidateTemplate operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ValidateTemplateResultUnmarshaller"> <summary> ValidateTemplateResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.LimitExceededException"> <summary> AmazonCloudFormation exception </summary> </member> <member name="M:Amazon.CloudFormation.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFormation.Model.ListStackResourcesRequest"> <summary> Container for the parameters to the ListStackResources operation. <para>Returns descriptions of all resources of the specified stack.</para> <para>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.ListStackResourcesRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ListStackResourcesRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesRequest.StackName"> <summary> The name or the unique identifier associated with the stack, which are not always interchangeable: <ul> <li>Running stacks: You can specify either the stack's name or its unique stack ID.</li> <li>Deleted stacks: You must specify the unique stack ID.</li> </ul> Default: There is no default value. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesRequest.NextToken"> <summary> String that identifies the start of the next list of stack resource summaries, if there is one. Default: There is no default value. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStackResourcesResponse"> <summary> Returns information about the ListStackResourcesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesResponse.ListStackResourcesResult"> <summary> Gets and sets the ListStackResourcesResult property. The output for a ListStackResources action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStackResourcesResult"> <summary> <para>The output for a ListStackResources action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.ListStackResourcesResult.WithStackResourceSummaries(Amazon.CloudFormation.Model.StackResourceSummary[])"> <summary> Adds elements to the StackResourceSummaries collection </summary> <param name="stackResourceSummaries">The values to add to the StackResourceSummaries collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ListStackResourcesResult.WithStackResourceSummaries(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.StackResourceSummary})"> <summary> Adds elements to the StackResourceSummaries collection </summary> <param name="stackResourceSummaries">The values to add to the StackResourceSummaries collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ListStackResourcesResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesResult.StackResourceSummaries"> <summary> A list of <c>StackResourceSummary</c> structures. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesResult.NextToken"> <summary> String that identifies the start of the next list of events, if there is one. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStacksRequest"> <summary> Container for the parameters to the ListStacks operation. <para>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).</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.ListStacksRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ListStacksRequest.WithStackStatusFilter(System.String[])"> <summary> Adds elements to the StackStatusFilter collection </summary> <param name="stackStatusFilter">The values to add to the StackStatusFilter collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ListStacksRequest.WithStackStatusFilter(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the StackStatusFilter collection </summary> <param name="stackStatusFilter">The values to add to the StackStatusFilter collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksRequest.NextToken"> <summary> String that identifies the start of the next list of stacks, if there is one. Default: There is no default value. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksRequest.StackStatusFilter"> <summary> Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the <c>StackStatus</c> parameter of the <a>Stack</a> data type. </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStacksResponse"> <summary> Returns information about the ListStacksResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksResponse.ListStacksResult"> <summary> Gets and sets the ListStacksResult property. The output for ListStacks action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStacksResult"> <summary> <para>The output for ListStacks action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.ListStacksResult.WithStackSummaries(Amazon.CloudFormation.Model.StackSummary[])"> <summary> Adds elements to the StackSummaries collection </summary> <param name="stackSummaries">The values to add to the StackSummaries collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ListStacksResult.WithStackSummaries(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.StackSummary})"> <summary> Adds elements to the StackSummaries collection </summary> <param name="stackSummaries">The values to add to the StackSummaries collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ListStacksResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksResult.StackSummaries"> <summary> A list of <c>StackSummary</c> structures containing information about the specified stacks. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksResult.NextToken"> <summary> String that identifies the start of the next list of stacks, if there is one. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.Output"> <summary> <para>The Output data type.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.Output.WithOutputKey(System.String)"> <summary> Sets the OutputKey property </summary> <param name="outputKey">The value to set for the OutputKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Output.WithOutputValue(System.String)"> <summary> Sets the OutputValue property </summary> <param name="outputValue">The value to set for the OutputValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Output.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.Output.OutputKey"> <summary> The key associated with the output. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Output.OutputValue"> <summary> The value associated with the output. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Output.Description"> <summary> User defined description associated with the output. </summary> </member> <member name="T:Amazon.CloudFormation.Model.Parameter"> <summary> <para>The Parameter data type.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.Parameter.WithParameterKey(System.String)"> <summary> Sets the ParameterKey property </summary> <param name="parameterKey">The value to set for the ParameterKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Parameter.WithParameterValue(System.String)"> <summary> Sets the ParameterValue property </summary> <param name="parameterValue">The value to set for the ParameterValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Parameter.WithUsePreviousValue(System.Boolean)"> <summary> Sets the UsePreviousValue property </summary> <param name="usePreviousValue">The value to set for the UsePreviousValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.Parameter.ParameterKey"> <summary> The key associated with the parameter. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Parameter.ParameterValue"> <summary> The value associated with the parameter. </summary> </member> <member name="T:Amazon.CloudFormation.Model.SetStackPolicyRequest"> <summary> Container for the parameters to the SetStackPolicy operation. <para>Sets a stack policy for a specified stack.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.SetStackPolicyRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.SetStackPolicyRequest.WithStackPolicyBody(System.String)"> <summary> Sets the StackPolicyBody property </summary> <param name="stackPolicyBody">The value to set for the StackPolicyBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.SetStackPolicyRequest.WithStackPolicyURL(System.String)"> <summary> Sets the StackPolicyURL property </summary> <param name="stackPolicyURL">The value to set for the StackPolicyURL property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.SetStackPolicyRequest.StackName"> <summary> The name or stack ID that you want to associate a policy with. </summary> </member> <member name="P:Amazon.CloudFormation.Model.SetStackPolicyRequest.StackPolicyBody"> <summary> Structure containing the stack policy body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide.) You must pass <c>StackPolicyBody</c> or <c>StackPolicyURL</c>. If both are passed, only <c>StackPolicyBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 16384</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.SetStackPolicyRequest.StackPolicyURL"> <summary> Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You must pass <c>StackPolicyBody</c> or <c>StackPolicyURL</c>. If both are passed, only <c>StackPolicyBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1350</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.SetStackPolicyResponse"> <summary> Returns information about the SetStackPolicy response metadata. The SetStackPolicy operation has a void result type. </summary> </member> <member name="T:Amazon.CloudFormation.Model.Stack"> <summary> <para>The Stack data type.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithStackId(System.String)"> <summary> Sets the StackId property </summary> <param name="stackId">The value to set for the StackId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithParameters(Amazon.CloudFormation.Model.Parameter[])"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithParameters(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Parameter})"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithCreationTime(System.DateTime)"> <summary> Sets the CreationTime property </summary> <param name="creationTime">The value to set for the CreationTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithLastUpdatedTime(System.DateTime)"> <summary> Sets the LastUpdatedTime property </summary> <param name="lastUpdatedTime">The value to set for the LastUpdatedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithStackStatus(System.String)"> <summary> Sets the StackStatus property </summary> <param name="stackStatus">The value to set for the StackStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithStackStatusReason(System.String)"> <summary> Sets the StackStatusReason property </summary> <param name="stackStatusReason">The value to set for the StackStatusReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithDisableRollback(System.Boolean)"> <summary> Sets the DisableRollback property </summary> <param name="disableRollback">The value to set for the DisableRollback property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithNotificationARNs(System.String[])"> <summary> Adds elements to the NotificationARNs collection </summary> <param name="notificationARNs">The values to add to the NotificationARNs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithNotificationARNs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the NotificationARNs collection </summary> <param name="notificationARNs">The values to add to the NotificationARNs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithTimeoutInMinutes(System.Int32)"> <summary> Sets the TimeoutInMinutes property </summary> <param name="timeoutInMinutes">The value to set for the TimeoutInMinutes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithCapabilities(System.String[])"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithCapabilities(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithOutputs(Amazon.CloudFormation.Model.Output[])"> <summary> Adds elements to the Outputs collection </summary> <param name="outputs">The values to add to the Outputs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithOutputs(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Output})"> <summary> Adds elements to the Outputs collection </summary> <param name="outputs">The values to add to the Outputs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithTags(Amazon.CloudFormation.Model.Tag[])"> <summary> Adds elements to the Tags collection </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Stack.WithTags(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Tag})"> <summary> Adds elements to the Tags collection </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackId"> <summary> Unique identifier of the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackName"> <summary> The name associated with the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Description"> <summary> User defined description associated with the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Parameters"> <summary> A list of <c>Parameter</c> structures. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.CreationTime"> <summary> Time at which the stack was created. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.LastUpdatedTime"> <summary> The time the stack was last updated. This field will only be returned if the stack has been updated at least once. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackStatus"> <summary> Current status of the stack. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackStatusReason"> <summary> Success/failure message associated with the stack status. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.DisableRollback"> <summary> Boolean to enable or disable rollback on stack creation failures: <ul> <li><c>true</c>: disable rollback</li> <li><c>false</c>: enable rollback</li> </ul> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.NotificationARNs"> <summary> SNS topic ARNs to which stack related events are published. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.TimeoutInMinutes"> <summary> The amount of time within which stack creation should complete. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Capabilities"> <summary> The capabilities allowed in the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Outputs"> <summary> A list of output structures. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Tags"> <summary> A list of <c>Tag</c>s that specify cost allocation information for the stack. </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackEvent"> <summary> <para>The StackEvent data type.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithStackId(System.String)"> <summary> Sets the StackId property </summary> <param name="stackId">The value to set for the StackId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithEventId(System.String)"> <summary> Sets the EventId property </summary> <param name="eventId">The value to set for the EventId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithLogicalResourceId(System.String)"> <summary> Sets the LogicalResourceId property </summary> <param name="logicalResourceId">The value to set for the LogicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithPhysicalResourceId(System.String)"> <summary> Sets the PhysicalResourceId property </summary> <param name="physicalResourceId">The value to set for the PhysicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithResourceType(System.String)"> <summary> Sets the ResourceType property </summary> <param name="resourceType">The value to set for the ResourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithTimestamp(System.DateTime)"> <summary> Sets the Timestamp property </summary> <param name="timestamp">The value to set for the Timestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithResourceStatus(System.String)"> <summary> Sets the ResourceStatus property </summary> <param name="resourceStatus">The value to set for the ResourceStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithResourceStatusReason(System.String)"> <summary> Sets the ResourceStatusReason property </summary> <param name="resourceStatusReason">The value to set for the ResourceStatusReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackEvent.WithResourceProperties(System.String)"> <summary> Sets the ResourceProperties property </summary> <param name="resourceProperties">The value to set for the ResourceProperties property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.StackId"> <summary> The unique ID name of the instance of the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.EventId"> <summary> The unique ID of this event. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.StackName"> <summary> The name associated with a stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.LogicalResourceId"> <summary> The logical name of the resource specified in the template. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.PhysicalResourceId"> <summary> The name or unique identifier associated with the physical instance of the resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceType"> <summary> Type of resource. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.) </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.Timestamp"> <summary> Time the status was updated. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceStatus"> <summary> Current status of the resource. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceStatusReason"> <summary> Success/failure message associated with the resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceProperties"> <summary> BLOB of the properties used to create the resource. </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackResource"> <summary> <para>The StackResource data type.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithStackId(System.String)"> <summary> Sets the StackId property </summary> <param name="stackId">The value to set for the StackId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithLogicalResourceId(System.String)"> <summary> Sets the LogicalResourceId property </summary> <param name="logicalResourceId">The value to set for the LogicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithPhysicalResourceId(System.String)"> <summary> Sets the PhysicalResourceId property </summary> <param name="physicalResourceId">The value to set for the PhysicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithResourceType(System.String)"> <summary> Sets the ResourceType property </summary> <param name="resourceType">The value to set for the ResourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithTimestamp(System.DateTime)"> <summary> Sets the Timestamp property </summary> <param name="timestamp">The value to set for the Timestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithResourceStatus(System.String)"> <summary> Sets the ResourceStatus property </summary> <param name="resourceStatus">The value to set for the ResourceStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithResourceStatusReason(System.String)"> <summary> Sets the ResourceStatusReason property </summary> <param name="resourceStatusReason">The value to set for the ResourceStatusReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResource.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.StackName"> <summary> The name associated with the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.StackId"> <summary> Unique identifier of the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.LogicalResourceId"> <summary> The logical name of the resource specified in the template. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.PhysicalResourceId"> <summary> The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.ResourceType"> <summary> Type of resource. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.) </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.Timestamp"> <summary> Time the status was updated. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.ResourceStatus"> <summary> Current status of the resource. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.ResourceStatusReason"> <summary> Success/failure message associated with the resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.Description"> <summary> User defined description associated with the resource. </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackResourceDetail"> <summary> <para>Contains detailed information about the specified stack resource.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithStackId(System.String)"> <summary> Sets the StackId property </summary> <param name="stackId">The value to set for the StackId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithLogicalResourceId(System.String)"> <summary> Sets the LogicalResourceId property </summary> <param name="logicalResourceId">The value to set for the LogicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithPhysicalResourceId(System.String)"> <summary> Sets the PhysicalResourceId property </summary> <param name="physicalResourceId">The value to set for the PhysicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithResourceType(System.String)"> <summary> Sets the ResourceType property </summary> <param name="resourceType">The value to set for the ResourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithLastUpdatedTimestamp(System.DateTime)"> <summary> Sets the LastUpdatedTimestamp property </summary> <param name="lastUpdatedTimestamp">The value to set for the LastUpdatedTimestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithResourceStatus(System.String)"> <summary> Sets the ResourceStatus property </summary> <param name="resourceStatus">The value to set for the ResourceStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithResourceStatusReason(System.String)"> <summary> Sets the ResourceStatusReason property </summary> <param name="resourceStatusReason">The value to set for the ResourceStatusReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceDetail.WithMetadata(System.String)"> <summary> Sets the Metadata property </summary> <param name="metadata">The value to set for the Metadata property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.StackName"> <summary> The name associated with the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.StackId"> <summary> Unique identifier of the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.LogicalResourceId"> <summary> The logical name of the resource specified in the template. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.PhysicalResourceId"> <summary> The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.ResourceType"> <summary> Type of resource. ((For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.) </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.LastUpdatedTimestamp"> <summary> Time the status was updated. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.ResourceStatus"> <summary> Current status of the resource. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.ResourceStatusReason"> <summary> Success/failure message associated with the resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.Description"> <summary> User defined description associated with the resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.Metadata"> <summary> The JSON format content of the <c>Metadata</c> attribute declared for the resource. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html">Metadata Attribute</a> in the AWS CloudFormation User Guide. </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackResourceSummary"> <summary> <para>Contains high-level information about the specified stack resource.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceSummary.WithLogicalResourceId(System.String)"> <summary> Sets the LogicalResourceId property </summary> <param name="logicalResourceId">The value to set for the LogicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceSummary.WithPhysicalResourceId(System.String)"> <summary> Sets the PhysicalResourceId property </summary> <param name="physicalResourceId">The value to set for the PhysicalResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceSummary.WithResourceType(System.String)"> <summary> Sets the ResourceType property </summary> <param name="resourceType">The value to set for the ResourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceSummary.WithLastUpdatedTimestamp(System.DateTime)"> <summary> Sets the LastUpdatedTimestamp property </summary> <param name="lastUpdatedTimestamp">The value to set for the LastUpdatedTimestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceSummary.WithResourceStatus(System.String)"> <summary> Sets the ResourceStatus property </summary> <param name="resourceStatus">The value to set for the ResourceStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackResourceSummary.WithResourceStatusReason(System.String)"> <summary> Sets the ResourceStatusReason property </summary> <param name="resourceStatusReason">The value to set for the ResourceStatusReason property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.LogicalResourceId"> <summary> The logical name of the resource specified in the template. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.PhysicalResourceId"> <summary> The name or unique identifier that corresponds to a physical instance ID of the resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.ResourceType"> <summary> Type of resource. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.) </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.LastUpdatedTimestamp"> <summary> Time the status was updated. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.ResourceStatus"> <summary> Current status of the resource. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.ResourceStatusReason"> <summary> Success/failure message associated with the resource. </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackSummary"> <summary> <para>The StackSummary Data Type</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithStackId(System.String)"> <summary> Sets the StackId property </summary> <param name="stackId">The value to set for the StackId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithTemplateDescription(System.String)"> <summary> Sets the TemplateDescription property </summary> <param name="templateDescription">The value to set for the TemplateDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithCreationTime(System.DateTime)"> <summary> Sets the CreationTime property </summary> <param name="creationTime">The value to set for the CreationTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithLastUpdatedTime(System.DateTime)"> <summary> Sets the LastUpdatedTime property </summary> <param name="lastUpdatedTime">The value to set for the LastUpdatedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithDeletionTime(System.DateTime)"> <summary> Sets the DeletionTime property </summary> <param name="deletionTime">The value to set for the DeletionTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithStackStatus(System.String)"> <summary> Sets the StackStatus property </summary> <param name="stackStatus">The value to set for the StackStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.StackSummary.WithStackStatusReason(System.String)"> <summary> Sets the StackStatusReason property </summary> <param name="stackStatusReason">The value to set for the StackStatusReason property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackId"> <summary> Unique stack identifier. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackName"> <summary> The name associated with the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.TemplateDescription"> <summary> The template description of the template used to create the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.CreationTime"> <summary> The time the stack was created. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.LastUpdatedTime"> <summary> The time the stack was last updated. This field will only be returned if the stack has been updated at least once. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.DeletionTime"> <summary> The time the stack was deleted. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackStatus"> <summary> The current status of the stack. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackStatusReason"> <summary> Success/Failure message associated with the stack status. </summary> </member> <member name="T:Amazon.CloudFormation.Model.Tag"> <summary> <para>The Tag type is used by <c>CreateStack</c> in the <c>Tags</c> parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.Tag.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.Tag.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.Tag.Key"> <summary> <i>Required</i>. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: <c>aws:</c>. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Tag.Value"> <summary> <i>Required</i>. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. </summary> </member> <member name="T:Amazon.CloudFormation.Model.TemplateParameter"> <summary> <para>The TemplateParameter data type.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.TemplateParameter.WithParameterKey(System.String)"> <summary> Sets the ParameterKey property </summary> <param name="parameterKey">The value to set for the ParameterKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.TemplateParameter.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.TemplateParameter.WithNoEcho(System.Boolean)"> <summary> Sets the NoEcho property </summary> <param name="noEcho">The value to set for the NoEcho property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.TemplateParameter.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.ParameterKey"> <summary> The name associated with the parameter. </summary> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.DefaultValue"> <summary> The default value associated with the parameter. </summary> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.NoEcho"> <summary> Flag indicating whether the parameter should be displayed as plain text in logs and UIs. </summary> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.Description"> <summary> User defined description associated with the parameter. </summary> </member> <member name="T:Amazon.CloudFormation.Model.UpdateStackRequest"> <summary> Container for the parameters to the UpdateStack operation. <para>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 DescribeStacks action.</para> <para> <b>Note: </b> You cannot update <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html">AWS::S3::Bucket</a> resources, for example, to add or modify tags.</para> <para>To get a copy of the template for an existing stack, you can use the GetTemplate action.</para> <para>Tags that were associated with this stack during creation time will still be associated with the stack after an <c>UpdateStack</c> operation.</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> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"/> <summary> Container for the parameters to the UpdateStack operation. <para>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 DescribeStacks action.</para> <para> <b>Note: </b> You cannot update <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html">AWS::S3::Bucket</a> resources, for example, to add or modify tags.</para> <para>To get a copy of the template for an existing stack, you can use the GetTemplate action.</para> <para>Tags that were associated with this stack during creation time will still be associated with the stack after an <c>UpdateStack</c> operation.</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> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithStackName(System.String)"> <summary> Sets the StackName property </summary> <param name="stackName">The value to set for the StackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithTemplateBody(System.String)"> <summary> Sets the TemplateBody property </summary> <param name="templateBody">The value to set for the TemplateBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithTemplateURL(System.String)"> <summary> Sets the TemplateURL property </summary> <param name="templateURL">The value to set for the TemplateURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithUsePreviousTemplate(System.Boolean)"> <summary> Sets the UsePreviousTemplate property </summary> <param name="usePreviousTemplate">The value to set for the UsePreviousTemplate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithStackPolicyDuringUpdateBody(System.String)"> <summary> Sets the StackPolicyDuringUpdateBody property </summary> <param name="stackPolicyDuringUpdateBody">The value to set for the StackPolicyDuringUpdateBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithStackPolicyDuringUpdateURL(System.String)"> <summary> Sets the StackPolicyDuringUpdateURL property </summary> <param name="stackPolicyDuringUpdateURL">The value to set for the StackPolicyDuringUpdateURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithParameters(Amazon.CloudFormation.Model.Parameter[])"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithParameters(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.Parameter})"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithCapabilities(System.String[])"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithCapabilities(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithStackPolicyBody(System.String)"> <summary> Sets the StackPolicyBody property </summary> <param name="stackPolicyBody">The value to set for the StackPolicyBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithStackPolicyURL(System.String)"> <summary> Sets the StackPolicyURL property </summary> <param name="stackPolicyURL">The value to set for the StackPolicyURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithNotificationARNs(System.String[])"> <summary> Adds elements to the NotificationARNs collection </summary> <param name="notificationARNs">The values to add to the NotificationARNs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackRequest.WithNotificationARNs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the NotificationARNs collection </summary> <param name="notificationARNs">The values to add to the NotificationARNs collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackName"> <summary> The name or stack ID of the stack to update. <note> Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters. </note> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.TemplateBody"> <summary> Structure containing the template body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.) Conditional: You must pass <c>TemplateBody</c> or <c>TemplateURL</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.TemplateURL"> <summary> Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide. Conditional: You must pass <c>TemplateURL</c> or <c>TemplateBody</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyDuringUpdateBody"> <summary> Structure containing the temporary overriding stack policy body. If you pass <c>StackPolicyDuringUpdateBody</c> and <c>StackPolicyDuringUpdateURL</c>, only <c>StackPolicyDuringUpdateBody</c> is used. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that associated with the stack will be used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 16384</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyDuringUpdateURL"> <summary> Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. If you pass <c>StackPolicyDuringUpdateBody</c> and <c>StackPolicyDuringUpdateURL</c>, only <c>StackPolicyDuringUpdateBody</c> is used. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1350</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.Parameters"> <summary> A list of <c>Parameter</c> structures that specify input parameters for the stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.Capabilities"> <summary> The list of capabilities that you want to allow in the stack. If your stack contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html">AWS::IAM::AccessKey</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">AWS::IAM::Group</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html">AWS::IAM::Policy</a>, <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html">AWS::IAM::User</a>, and <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>. </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyBody"> <summary> Structure containing the updated stack policy body. If you pass <c>StackPolicyBody</c> and <c>StackPolicyURL</c>, only <c>StackPolicyBody</c> is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 16384</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyURL"> <summary> Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. If you pass <c>StackPolicyBody</c> and <c>StackPolicyURL</c>, only <c>StackPolicyBody</c> is used. If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1350</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.UpdateStackResponse"> <summary> Returns information about the UpdateStackResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackResponse.UpdateStackResult"> <summary> Gets and sets the UpdateStackResult property. The output for a UpdateStack action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.UpdateStackResult"> <summary> <para>The output for a UpdateStack action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.UpdateStackResult.WithStackId(System.String)"> <summary> Sets the StackId property </summary> <param name="stackId">The value to set for the StackId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackResult.StackId"> <summary> Unique identifier of the stack. </summary> </member> <member name="T:Amazon.CloudFormation.Model.ValidateTemplateRequest"> <summary> Container for the parameters to the ValidateTemplate operation. <para>Validates a specified template.</para> </summary> <seealso cref="M:Amazon.CloudFormation.AmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"/> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateRequest.WithTemplateBody(System.String)"> <summary> Sets the TemplateBody property </summary> <param name="templateBody">The value to set for the TemplateBody property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateRequest.WithTemplateURL(System.String)"> <summary> Sets the TemplateURL property </summary> <param name="templateURL">The value to set for the TemplateURL property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateRequest.TemplateBody"> <summary> String containing the template body. (For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide.) Conditional: You must pass <c>TemplateURL</c> or <c>TemplateBody</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateRequest.TemplateURL"> <summary> Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide. Conditional: You must pass <c>TemplateURL</c> or <c>TemplateBody</c>. If both are passed, only <c>TemplateBody</c> is used. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ValidateTemplateResponse"> <summary> Returns information about the ValidateTemplateResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResponse.ValidateTemplateResult"> <summary> Gets and sets the ValidateTemplateResult property. The output for ValidateTemplate action. </summary> </member> <member name="T:Amazon.CloudFormation.Model.ValidateTemplateResult"> <summary> <para>The output for ValidateTemplate action.</para> </summary> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateResult.WithParameters(Amazon.CloudFormation.Model.TemplateParameter[])"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateResult.WithParameters(System.Collections.Generic.IEnumerable{Amazon.CloudFormation.Model.TemplateParameter})"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateResult.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateResult.WithCapabilities(System.String[])"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateResult.WithCapabilities(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Capabilities collection </summary> <param name="capabilities">The values to add to the Capabilities collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFormation.Model.ValidateTemplateResult.WithCapabilitiesReason(System.String)"> <summary> Sets the CapabilitiesReason property </summary> <param name="capabilitiesReason">The value to set for the CapabilitiesReason property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.Parameters"> <summary> A list of <c>TemplateParameter</c> structures. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.Description"> <summary> The description found within the template. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.Capabilities"> <summary> The capabilities found within the template. Currently, CAPABILITY_IAM is the only capability detected. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.CapabilitiesReason"> <summary> The capabilities reason found within the template. </summary> </member> <member name="M:Amazon.CloudFormation.Util.AmazonCloudFormationUtil.SignalWaitCondition(System.String,System.String,System.String,System.String,System.String)"> <summary> This method will signal to the CloudFormation the status of a wait condition. </summary> <param name="presignedURL">The URL returned from the creation of a WaitHandle in a CloudFormation Stack</param> <param name="status">SUCCESS or FAILURE for the status of a stack</param> <param name="reason">The reason for the status</param> <param name="uniqueId">A unique identifier for the signal. Using <c>Guid.NewGuid().ToString()</c>can be used for this.</param> <param name="data">Data to be passed back for later use in the template.</param> </member> <member name="T:Amazon.CloudFront.AmazonCloudFront"> <summary> Implementation for accessing CloudFront </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.BeginCreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndCreateCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCloudFrontOriginAccessIdentity.</param> <returns>Returns a CreateCloudFrontOriginAccessIdentityResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.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.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.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.AmazonCloudFront.BeginCreateDistribution(Amazon.CloudFront.Model.CreateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndCreateDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDistribution.</param> <returns>Returns a CreateDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.BeginCreateInvalidation(Amazon.CloudFront.Model.CreateInvalidationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateInvalidation operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInvalidation operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndCreateInvalidation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInvalidation.</param> <returns>Returns a CreateInvalidationResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.BeginCreateStreamingDistribution(Amazon.CloudFront.Model.CreateStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndCreateStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStreamingDistribution.</param> <returns>Returns a CreateStreamingDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginDeleteCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndDeleteCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCloudFrontOriginAccessIdentity.</param> <returns>Returns a DeleteCloudFrontOriginAccessIdentityResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginDeleteDistribution(Amazon.CloudFront.Model.DeleteDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndDeleteDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDistribution.</param> <returns>Returns a DeleteDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginDeleteStreamingDistribution(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndDeleteStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteStreamingDistribution.</param> <returns>Returns a DeleteStreamingDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginGetCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndGetCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCloudFrontOriginAccessIdentity.</param> <returns>Returns a GetCloudFrontOriginAccessIdentityResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginGetCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentityConfig operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCloudFrontOriginAccessIdentityConfig operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndGetCloudFrontOriginAccessIdentityConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCloudFrontOriginAccessIdentityConfig.</param> <returns>Returns a GetCloudFrontOriginAccessIdentityConfigResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginGetDistribution(Amazon.CloudFront.Model.GetDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndGetDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDistribution.</param> <returns>Returns a GetDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginGetDistributionConfig(Amazon.CloudFront.Model.GetDistributionConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetDistributionConfig operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDistributionConfig operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndGetDistributionConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDistributionConfig.</param> <returns>Returns a GetDistributionConfigResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.BeginGetInvalidation(Amazon.CloudFront.Model.GetInvalidationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetInvalidation operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetInvalidation operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndGetInvalidation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetInvalidation.</param> <returns>Returns a GetInvalidationResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginGetStreamingDistribution(Amazon.CloudFront.Model.GetStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndGetStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStreamingDistribution.</param> <returns>Returns a GetStreamingDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginGetStreamingDistributionConfig(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStreamingDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistributionConfig operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStreamingDistributionConfig operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndGetStreamingDistributionConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStreamingDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStreamingDistributionConfig.</param> <returns>Returns a GetStreamingDistributionConfigResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginListCloudFrontOriginAccessIdentities(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListCloudFrontOriginAccessIdentities operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListCloudFrontOriginAccessIdentities operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndListCloudFrontOriginAccessIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListCloudFrontOriginAccessIdentities.</param> <returns>Returns a ListCloudFrontOriginAccessIdentitiesResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginListDistributions(Amazon.CloudFront.Model.ListDistributionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListDistributions operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDistributions operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndListDistributions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDistributions.</param> <returns>Returns a ListDistributionsResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.BeginListInvalidations(Amazon.CloudFront.Model.ListInvalidationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInvalidations operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInvalidations operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInvalidations operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndListInvalidations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInvalidations operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInvalidations.</param> <returns>Returns a ListInvalidationsResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.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.AmazonCloudFront.BeginListStreamingDistributions(Amazon.CloudFront.Model.ListStreamingDistributionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStreamingDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListStreamingDistributions operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStreamingDistributions operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndListStreamingDistributions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStreamingDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStreamingDistributions.</param> <returns>Returns a ListStreamingDistributionsResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.BeginUpdateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndUpdateCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateCloudFrontOriginAccessIdentity.</param> <returns>Returns a UpdateCloudFrontOriginAccessIdentityResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.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.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.AmazonCloudFront.BeginUpdateDistribution(Amazon.CloudFront.Model.UpdateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndUpdateDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDistribution.</param> <returns>Returns a UpdateDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.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.AmazonCloudFront.BeginUpdateStreamingDistribution(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFront.EndUpdateStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStreamingDistribution.</param> <returns>Returns a UpdateStreamingDistributionResult from CloudFront.</returns> </member> <member name="T:Amazon.CloudFront.AmazonCloudFrontClient"> <summary> Implementation for accessing CloudFront </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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.BeginCreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndCreateCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCloudFrontOriginAccessIdentity.</param> <returns>Returns a CreateCloudFrontOriginAccessIdentityResult from CloudFront.</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.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.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.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.BeginCreateDistribution(Amazon.CloudFront.Model.CreateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndCreateDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDistribution.</param> <returns>Returns a CreateDistributionResult from CloudFront.</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.BeginCreateInvalidation(Amazon.CloudFront.Model.CreateInvalidationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateInvalidation operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInvalidation operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndCreateInvalidation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInvalidation.</param> <returns>Returns a CreateInvalidationResult from CloudFront.</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.BeginCreateStreamingDistribution(Amazon.CloudFront.Model.CreateStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndCreateStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStreamingDistribution.</param> <returns>Returns a CreateStreamingDistributionResult from CloudFront.</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.BeginDeleteCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndDeleteCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCloudFrontOriginAccessIdentity.</param> <returns>Returns a DeleteCloudFrontOriginAccessIdentityResult from CloudFront.</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.BeginDeleteDistribution(Amazon.CloudFront.Model.DeleteDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndDeleteDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDistribution.</param> <returns>Returns a DeleteDistributionResult from CloudFront.</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.BeginDeleteStreamingDistribution(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndDeleteStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteStreamingDistribution.</param> <returns>Returns a DeleteStreamingDistributionResult from CloudFront.</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.BeginGetCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndGetCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCloudFrontOriginAccessIdentity.</param> <returns>Returns a GetCloudFrontOriginAccessIdentityResult from CloudFront.</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.BeginGetCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentityConfig operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCloudFrontOriginAccessIdentityConfig operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndGetCloudFrontOriginAccessIdentityConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCloudFrontOriginAccessIdentityConfig.</param> <returns>Returns a GetCloudFrontOriginAccessIdentityConfigResult from CloudFront.</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.BeginGetDistribution(Amazon.CloudFront.Model.GetDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndGetDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDistribution.</param> <returns>Returns a GetDistributionResult from CloudFront.</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.BeginGetDistributionConfig(Amazon.CloudFront.Model.GetDistributionConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetDistributionConfig operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDistributionConfig operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndGetDistributionConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDistributionConfig.</param> <returns>Returns a GetDistributionConfigResult from CloudFront.</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.BeginGetInvalidation(Amazon.CloudFront.Model.GetInvalidationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetInvalidation operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetInvalidation operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndGetInvalidation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetInvalidation operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetInvalidation.</param> <returns>Returns a GetInvalidationResult from CloudFront.</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.BeginGetStreamingDistribution(Amazon.CloudFront.Model.GetStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndGetStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStreamingDistribution.</param> <returns>Returns a GetStreamingDistributionResult from CloudFront.</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.BeginGetStreamingDistributionConfig(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStreamingDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistributionConfig operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetStreamingDistributionConfig operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndGetStreamingDistributionConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStreamingDistributionConfig operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStreamingDistributionConfig.</param> <returns>Returns a GetStreamingDistributionConfigResult from CloudFront.</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.BeginListCloudFrontOriginAccessIdentities(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListCloudFrontOriginAccessIdentities operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListCloudFrontOriginAccessIdentities operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndListCloudFrontOriginAccessIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListCloudFrontOriginAccessIdentities.</param> <returns>Returns a ListCloudFrontOriginAccessIdentitiesResult from CloudFront.</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.BeginListDistributions(Amazon.CloudFront.Model.ListDistributionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListDistributions operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDistributions operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndListDistributions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDistributions.</param> <returns>Returns a ListDistributionsResult from CloudFront.</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.BeginListInvalidations(Amazon.CloudFront.Model.ListInvalidationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInvalidations operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInvalidations operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInvalidations operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndListInvalidations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInvalidations operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInvalidations.</param> <returns>Returns a ListInvalidationsResult from CloudFront.</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.BeginListStreamingDistributions(Amazon.CloudFront.Model.ListStreamingDistributionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStreamingDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the ListStreamingDistributions operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStreamingDistributions operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndListStreamingDistributions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStreamingDistributions operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStreamingDistributions.</param> <returns>Returns a ListStreamingDistributionsResult from CloudFront.</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.BeginUpdateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateCloudFrontOriginAccessIdentity operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateCloudFrontOriginAccessIdentity operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndUpdateCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateCloudFrontOriginAccessIdentity.</param> <returns>Returns a UpdateCloudFrontOriginAccessIdentityResult from CloudFront.</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.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.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.BeginUpdateDistribution(Amazon.CloudFront.Model.UpdateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndUpdateDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDistribution.</param> <returns>Returns a UpdateDistributionResult from CloudFront.</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.BeginUpdateStreamingDistribution(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStreamingDistribution operation on AmazonCloudFrontClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStreamingDistribution operation.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.EndUpdateStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStreamingDistribution operation. <seealso cref="T:Amazon.CloudFront.AmazonCloudFront"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStreamingDistribution.</param> <returns>Returns a UpdateStreamingDistributionResult from CloudFront.</returns> </member> <member name="T:Amazon.CloudFront.AmazonCloudFrontConfig"> <summary> Configuration for accessing Amazon CloudFront service </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudFront.AmazonCloudFrontConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudFront.AmazonCloudFrontConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.GetCannedSignedURL(Amazon.CloudFront.AmazonCloudFrontUrlSigner.Protocol,System.String,System.IO.FileInfo,System.String,System.String,System.DateTime)"> <summary> Returns a signed URL that grants universal access to private content until a given date. </summary> <param name="protocol">The protocol of the URL</param> <param name="distributionDomain">The domain name of the distribution</param> <param name="s3ObjectKey">The s3 key of the object, or the name of the stream for rtmp</param> <param name="privateKey">The private key file. RSA private key (.pem) are supported.</param> <param name="keyPairId">The key pair id corresponding to the private key file given</param> <param name="dateLessThan">The expiration date of the signed URL</param> <returns>The signed URL.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.GetCannedSignedURL(Amazon.CloudFront.AmazonCloudFrontUrlSigner.Protocol,System.String,System.IO.StreamReader,System.String,System.String,System.DateTime)"> <summary> Returns a signed URL that grants universal access to private content until a given date. </summary> <param name="protocol">The protocol of the URL</param> <param name="distributionDomain">The domain name of the distribution</param> <param name="s3ObjectKey">The s3 key of the object, or the name of the stream for rtmp</param> <param name="privateKey">The private key file. RSA private key (.pem) are supported.</param> <param name="keyPairId">The key pair id corresponding to the private key file given</param> <param name="dateLessThan">The expiration date of the signed URL</param> <returns>The signed URL.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.GetCustomSignedURL(Amazon.CloudFront.AmazonCloudFrontUrlSigner.Protocol,System.String,System.IO.FileInfo,System.String,System.String,System.DateTime,System.Nullable{System.DateTime},System.String)"> <summary> Returns a signed URL that provides tailored access to private content based on an access time window and an ip range. </summary> <param name="protocol">The protocol of the URL</param> <param name="distributionDomain">The domain name of the distribution</param> <param name="privateKey">Your private key file. RSA private key (.pem) are supported.</param> <param name="s3ObjectKey">The s3 key of the object, or the name of the stream for rtmp</param> <param name="keyPairId">The key pair id corresponding to the private key file given</param> <param name="dateLessThan">The expiration date of the signed URL</param> <param name="dateGreaterThan">The beginning valid date of the signed URL</param> <param name="ipRange">The allowed IP address range of the client making the GET request, in CIDR form (e.g. 192.168.0.1/24).</param> <returns>The signed URL.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.GetCustomSignedURL(Amazon.CloudFront.AmazonCloudFrontUrlSigner.Protocol,System.String,System.IO.StreamReader,System.String,System.String,System.DateTime,System.Nullable{System.DateTime},System.String)"> <summary> Returns a signed URL that provides tailored access to private content based on an access time window and an ip range. </summary> <param name="protocol">The protocol of the URL</param> <param name="distributionDomain">The domain name of the distribution</param> <param name="privateKey">Your private key file. RSA private key (.pem) are supported.</param> <param name="s3ObjectKey">The s3 key of the object, or the name of the stream for rtmp</param> <param name="keyPairId">The key pair id corresponding to the private key file given</param> <param name="dateLessThan">The expiration date of the signed URL</param> <param name="dateGreaterThan">The beginning valid date of the signed URL</param> <param name="ipRange">The allowed IP address range of the client making the GET request, in CIDR form (e.g. 192.168.0.1/24).</param> <returns>The signed URL.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.SignUrl(System.String,System.String,System.IO.FileInfo,System.String)"> <summary> Generate a signed URL that allows access to distribution and S3 objects by applying access restrictions specified in a custom policy document. </summary> <param name="resourceUrlOrPath"> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <tt>"http://" + distributionName + "/" + objectKey</tt> (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with <tt>"https://"</tt>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </param> <param name="keyPairId">Identifier of a public/private certificate keypair already configured in your Amazon Web Services account.</param> <param name="privateKey">The RSA private key data that corresponding to the certificate keypair identified by keyPairId.</param> <param name="policy">A policy document that describes the access permissions that will be applied by the signed URL. To generate a custom policy use</param> <returns>A signed URL that will permit access to distribution and S3 objects as specified in the policy document.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.SignUrl(System.String,System.String,System.IO.StreamReader,System.String)"> <summary> Generate a signed URL that allows access to distribution and S3 objects by applying access restrictions specified in a custom policy document. </summary> <param name="resourceUrlOrPath"> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <tt>"http://" + distributionName + "/" + objectKey</tt> (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with <tt>"https://"</tt>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </param> <param name="keyPairId">Identifier of a public/private certificate keypair already configured in your Amazon Web Services account.</param> <param name="privateKey">The RSA private key data that corresponding to the certificate keypair identified by keyPairId.</param> <param name="policy">A policy document that describes the access permissions that will be applied by the signed URL. To generate a custom policy use</param> <returns>A signed URL that will permit access to distribution and S3 objects as specified in the policy document.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.SignUrlCanned(System.String,System.String,System.IO.FileInfo,System.DateTime)"> <summary> Generate a signed URL that allows access to a specific distribution and S3 object by applying a access restrictions from a "canned" (simplified) policy document. </summary> <param name="resourceUrlOrPath"> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <tt>"http://" + distributionName + "/" + objectKey</tt> (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with <tt>"https://"</tt>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </param> <param name="keyPairId">Identifier of a public/private certificate keypair already configured in your Amazon Web Services account.</param> <param name="privateKey">The RSA private key data that corresponding to the certificate keypair identified by keyPairId.</param> <param name="dateLessThan">The time and date when the signed URL will expire.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.SignUrlCanned(System.String,System.String,System.IO.StreamReader,System.DateTime)"> <summary> Generate a signed URL that allows access to a specific distribution and S3 object by applying a access restrictions from a "canned" (simplified) policy document. </summary> <param name="resourceUrlOrPath"> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <tt>"http://" + distributionName + "/" + objectKey</tt> (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with <tt>"https://"</tt>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. </param> <param name="keyPairId">Identifier of a public/private certificate keypair already configured in your Amazon Web Services account.</param> <param name="privateKey">The RSA private key data that corresponding to the certificate keypair identified by keyPairId.</param> <param name="dateLessThan">The time and date when the signed URL will expire.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.BuildPolicyForSignedUrl(System.String,System.DateTime,System.String,System.Nullable{System.DateTime})"> <summary> Generate a policy document that describes custom access permissions to apply via a private distribution's signed URL. </summary> <param name="resourcePath"> An optional HTTP/S or RTMP resource path that restricts which distribution and S3 objects will be accessible in a signed URL. For standard distributions the resource URL will be <tt>"http://" + distributionName + "/" + objectKey</tt> (may also include URL parameters. For distributions with the HTTPS required protocol, the resource URL must start with <tt>"https://"</tt>. RTMP resources do not take the form of a URL, and instead the resource path is nothing but the stream's name. The '*' and '?' characters can be used as a wildcards to allow multi-character or single-character matches respectively: <ul> <li><tt>*</tt> : All distributions/objects will be accessible</li> <li><tt>a1b2c3d4e5f6g7.cloudfront.net/*</tt> : All objects within the distribution a1b2c3d4e5f6g7 will be accessible</li> <li><tt>a1b2c3d4e5f6g7.cloudfront.net/path/to/object.txt</tt> : Only the S3 object named <tt>path/to/object.txt</tt> in the distribution a1b2c3d4e5f6g7 will be accessible.</li> </ul> If this parameter is null the policy will permit access to all distributions and S3 objects associated with the certificate keypair used to generate the signed URL. </param> <param name="epochDateGreaterThan">The time and date when the signed URL will expire.</param> <param name="limitToIpAddressCIDR">An optional range of client IP addresses that will be allowed to access the distribution, specified as a CIDR range. If null, the CIDR will be <tt>0.0.0.0/0</tt> and any client will be permitted.</param> <param name="epochDateLessThan">An optional UTC time and date when the signed URL will become active. If null, the signed URL will be active as soon as it is created.</param> <returns>A policy document describing the access permission to apply when generating a signed URL.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.MakeBytesUrlSafe(System.Byte[])"> <summary> Converts the given data to be safe for use in signed URLs for a private distribution by using specialized Base64 encoding. </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.MakeStringUrlSafe(System.String)"> <summary> Converts the given string to be safe for use in signed URLs for a private distribution. </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.GenerateResourcePath(Amazon.CloudFront.AmazonCloudFrontUrlSigner.Protocol,System.String,System.String)"> <summary> Returns the resource path for the given distribution, object, and protocol. </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.SignWithSha1RSA(System.Byte[],System.Security.Cryptography.RSAParameters)"> <summary> Signs the data given with the private key given, using the SHA1withRSA algorithm provided by bouncy castle. </summary> </member> <member name="T:Amazon.CloudFront.Model.AccessDeniedException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.AccessDeniedException.#ctor(System.String)"> <summary> Constructs a new AccessDeniedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.ActiveTrustedSigners"> <summary> A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content. </summary> </member> <member name="M:Amazon.CloudFront.Model.ActiveTrustedSigners.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ActiveTrustedSigners.WithItems(Amazon.CloudFront.Model.Signer[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ActiveTrustedSigners.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.Signer})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ActiveTrustedSigners.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ActiveTrustedSigners.Enabled"> <summary> Gets and sets the property Enabled. Each active trusted signer. </summary> </member> <member name="P:Amazon.CloudFront.Model.ActiveTrustedSigners.Items"> <summary> Gets and sets the property Items. A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors. </summary> </member> <member name="P:Amazon.CloudFront.Model.ActiveTrustedSigners.Quantity"> <summary> Gets and sets the property Quantity. The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3. </summary> </member> <member name="T:Amazon.CloudFront.Model.Aliases"> <summary> A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.Aliases.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Aliases.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Aliases.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Aliases.Items"> <summary> Gets and sets the property Items. Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items. </summary> </member> <member name="P:Amazon.CloudFront.Model.Aliases.Quantity"> <summary> Gets and sets the property Quantity. The number of CNAMEs, if any, for this distribution. </summary> </member> <member name="T:Amazon.CloudFront.Model.AllowedMethods"> <summary> A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are two options: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests. If you choose the second option, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin. </summary> </member> <member name="M:Amazon.CloudFront.Model.AllowedMethods.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.AllowedMethods.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.AllowedMethods.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.AllowedMethods.Items"> <summary> Gets and sets the property Items. A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin. </summary> </member> <member name="P:Amazon.CloudFront.Model.AllowedMethods.Quantity"> <summary> Gets and sets the property Quantity. The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests). </summary> </member> <member name="T:Amazon.CloudFront.Model.BatchTooLargeException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.BatchTooLargeException.#ctor(System.String)"> <summary> Constructs a new BatchTooLargeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.CacheBehavior"> <summary> A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithAllowedMethods(Amazon.CloudFront.Model.AllowedMethods)"> <summary> Sets the AllowedMethods property </summary> <param name="allowedMethods">The value to set for the AllowedMethods property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithForwardedValues(Amazon.CloudFront.Model.ForwardedValues)"> <summary> Sets the ForwardedValues property </summary> <param name="forwardedValues">The value to set for the ForwardedValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithMinTTL(System.Int64)"> <summary> Sets the MinTTL property </summary> <param name="minTTL">The value to set for the MinTTL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithPathPattern(System.String)"> <summary> Sets the PathPattern property </summary> <param name="pathPattern">The value to set for the PathPattern property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithSmoothStreaming(System.Boolean)"> <summary> Sets the SmoothStreaming property </summary> <param name="smoothStreaming">The value to set for the SmoothStreaming property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithTargetOriginId(System.String)"> <summary> Sets the TargetOriginId property </summary> <param name="targetOriginId">The value to set for the TargetOriginId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithTrustedSigners(Amazon.CloudFront.Model.TrustedSigners)"> <summary> Sets the TrustedSigners property </summary> <param name="trustedSigners">The value to set for the TrustedSigners property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehavior.WithViewerProtocolPolicy(System.String)"> <summary> Sets the ViewerProtocolPolicy property </summary> <param name="viewerProtocolPolicy">The value to set for the ViewerProtocolPolicy property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.AllowedMethods"> <summary> Gets and sets the property AllowedMethods. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.ForwardedValues"> <summary> Gets and sets the property ForwardedValues. A complex type that specifies how CloudFront handles query strings, cookies and headers. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.MinTTL"> <summary> Gets and sets the property MinTTL. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years). </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.PathPattern"> <summary> Gets and sets the property PathPattern. The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.SmoothStreaming"> <summary> Gets and sets the property SmoothStreaming. Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.TargetOriginId"> <summary> Gets and sets the property TargetOriginId. The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.TrustedSigners"> <summary> Gets and sets the property TrustedSigners. A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.ViewerProtocolPolicy"> <summary> Gets and sets the property ViewerProtocolPolicy. Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL. </summary> </member> <member name="T:Amazon.CloudFront.Model.CacheBehaviors"> <summary> A complex type that contains zero or more CacheBehavior elements. </summary> </member> <member name="M:Amazon.CloudFront.Model.CacheBehaviors.WithItems(Amazon.CloudFront.Model.CacheBehavior[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehaviors.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.CacheBehavior})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CacheBehaviors.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CacheBehaviors.Items"> <summary> Gets and sets the property Items. Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehaviors.Quantity"> <summary> Gets and sets the property Quantity. The number of cache behaviors for this distribution. </summary> </member> <member name="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity"> <summary> CloudFront origin access identity. </summary> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity.WithCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Sets the CloudFrontOriginAccessIdentityConfig property </summary> <param name="cloudFrontOriginAccessIdentityConfig">The value to set for the CloudFrontOriginAccessIdentityConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity.WithS3CanonicalUserId(System.String)"> <summary> Sets the S3CanonicalUserId property </summary> <param name="s3CanonicalUserId">The value to set for the S3CanonicalUserId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity.CloudFrontOriginAccessIdentityConfig"> <summary> Gets and sets the property CloudFrontOriginAccessIdentityConfig. The current configuration information for the identity. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity.Id"> <summary> Gets and sets the property Id. The ID for the origin access identity. For example: E74FTE3AJFJ256A. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity.S3CanonicalUserId"> <summary> Gets and sets the property S3CanonicalUserId. The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3. </summary> </member> <member name="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityAlreadyExistsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new CloudFrontOriginAccessIdentityAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig"> <summary> Origin access identity configuration. </summary> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig.WithCallerReference(System.String)"> <summary> Sets the CallerReference property </summary> <param name="callerReference">The value to set for the CallerReference property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig.WithComment(System.String)"> <summary> Sets the Comment property </summary> <param name="comment">The value to set for the Comment property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig.CallerReference"> <summary> Gets and sets the property CallerReference. A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. 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. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig.Comment"> <summary> Gets and sets the property Comment. Any comments you want to include about the origin access identity. </summary> </member> <member name="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException.#ctor(System.String)"> <summary> Constructs a new CloudFrontOriginAccessIdentityInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList"> <summary> The CloudFrontOriginAccessIdentityList type. </summary> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.WithIsTruncated(System.Boolean)"> <summary> Sets the IsTruncated property </summary> <param name="isTruncated">The value to set for the IsTruncated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.WithItems(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.WithMaxItems(System.Int32)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.WithNextMarker(System.String)"> <summary> Sets the NextMarker property </summary> <param name="nextMarker">The value to set for the NextMarker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.IsTruncated"> <summary> Gets and sets the property IsTruncated. A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.Items"> <summary> Gets and sets the property Items. A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.Marker"> <summary> Gets and sets the property Marker. The value you provided for the Marker request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.MaxItems"> <summary> Gets and sets the property MaxItems. The value you provided for the MaxItems request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.NextMarker"> <summary> Gets and sets the property NextMarker. If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList.Quantity"> <summary> Gets and sets the property Quantity. The number of CloudFront origin access identities that were created by the current AWS account. </summary> </member> <member name="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary"> <summary> Summary of the information about a CloudFront origin access identity. </summary> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary.WithComment(System.String)"> <summary> Sets the Comment property </summary> <param name="comment">The value to set for the Comment property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary.WithS3CanonicalUserId(System.String)"> <summary> Sets the S3CanonicalUserId property </summary> <param name="s3CanonicalUserId">The value to set for the S3CanonicalUserId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary.Comment"> <summary> Gets and sets the property Comment. The comment for this origin access identity, as originally specified when created. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary.Id"> <summary> Gets and sets the property Id. The ID for the origin access identity. For example: E74FTE3AJFJ256A. </summary> </member> <member name="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentitySummary.S3CanonicalUserId"> <summary> Gets and sets the property S3CanonicalUserId. The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3. </summary> </member> <member name="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.CNAMEAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new CNAMEAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.CookieNames"> <summary> A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior. </summary> </member> <member name="M:Amazon.CloudFront.Model.CookieNames.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CookieNames.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CookieNames.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CookieNames.Items"> <summary> Gets and sets the property Items. Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items. </summary> </member> <member name="P:Amazon.CloudFront.Model.CookieNames.Quantity"> <summary> Gets and sets the property Quantity. The number of whitelisted cookies for this cache behavior. </summary> </member> <member name="T:Amazon.CloudFront.Model.CookiePreference"> <summary> A complex type that specifies the cookie preferences associated with this cache behavior. </summary> </member> <member name="M:Amazon.CloudFront.Model.CookiePreference.WithForward(System.String)"> <summary> Sets the Forward property </summary> <param name="forward">The value to set for the Forward property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CookiePreference.WithWhitelistedNames(Amazon.CloudFront.Model.CookieNames)"> <summary> Sets the WhitelistedNames property </summary> <param name="whitelistedNames">The value to set for the WhitelistedNames property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CookiePreference.Forward"> <summary> Gets and sets the property Forward. Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses. </summary> </member> <member name="P:Amazon.CloudFront.Model.CookiePreference.WhitelistedNames"> <summary> Gets and sets the property WhitelistedNames. A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest"> <summary> Container for the parameters to the CreateCloudFrontOriginAccessIdentity operation. Create a new origin access identity. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest.WithCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Sets the CloudFrontOriginAccessIdentityConfig property </summary> <param name="cloudFrontOriginAccessIdentityConfig">The value to set for the CloudFrontOriginAccessIdentityConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest.CloudFrontOriginAccessIdentityConfig"> <summary> Gets and sets the property CloudFrontOriginAccessIdentityConfig. The origin access identity's configuration information. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResponse"> <summary> Returns information about the CreateCloudFrontOriginAccessIdentityResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResponse.CreateCloudFrontOriginAccessIdentityResult"> <summary> Gets and sets the CreateCloudFrontOriginAccessIdentityResult property. Represents the output of a CreateCloudFrontOriginAccessIdentity operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult.WithCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity)"> <summary> Sets the CloudFrontOriginAccessIdentity property </summary> <param name="cloudFrontOriginAccessIdentity">The value to set for the CloudFrontOriginAccessIdentity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult.CloudFrontOriginAccessIdentity"> <summary> Gets and sets the property CloudFrontOriginAccessIdentity. The origin access identity's information. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult.ETag"> <summary> Gets and sets the property ETag. The current version of the origin access identity created. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult.Location"> <summary> Gets and sets the property Location. The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateDistributionRequest"> <summary> Container for the parameters to the CreateDistribution operation. Create a new distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateDistributionRequest.WithDistributionConfig(Amazon.CloudFront.Model.DistributionConfig)"> <summary> Sets the DistributionConfig property </summary> <param name="distributionConfig">The value to set for the DistributionConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateDistributionRequest.DistributionConfig"> <summary> Gets and sets the property DistributionConfig. The distribution's configuration information. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateDistributionResponse"> <summary> Returns information about the CreateDistributionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateDistributionResponse.CreateDistributionResult"> <summary> Gets and sets the CreateDistributionResult property. Represents the output of a CreateDistribution operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateDistributionResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateDistributionResult.WithDistribution(Amazon.CloudFront.Model.Distribution)"> <summary> Sets the Distribution property </summary> <param name="distribution">The value to set for the Distribution property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateDistributionResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateDistributionResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateDistributionResult.Distribution"> <summary> Gets and sets the property Distribution. The distribution's information. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateDistributionResult.ETag"> <summary> Gets and sets the property ETag. The current version of the distribution created. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateDistributionResult.Location"> <summary> Gets and sets the property Location. The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateInvalidationRequest"> <summary> Container for the parameters to the CreateInvalidation operation. Create a new invalidation. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateInvalidationRequest.WithDistributionId(System.String)"> <summary> Sets the DistributionId property </summary> <param name="distributionId">The value to set for the DistributionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateInvalidationRequest.WithInvalidationBatch(Amazon.CloudFront.Model.InvalidationBatch)"> <summary> Sets the InvalidationBatch property </summary> <param name="invalidationBatch">The value to set for the InvalidationBatch property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateInvalidationRequest.DistributionId"> <summary> Gets and sets the property DistributionId. The distribution's id. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateInvalidationRequest.InvalidationBatch"> <summary> Gets and sets the property InvalidationBatch. The batch information for the invalidation. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateInvalidationResponse"> <summary> Returns information about the CreateInvalidationResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateInvalidationResponse.CreateInvalidationResult"> <summary> Gets and sets the CreateInvalidationResult property. Represents the output of a CreateInvalidation operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateInvalidationResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateInvalidationResult.WithInvalidation(Amazon.CloudFront.Model.Invalidation)"> <summary> Sets the Invalidation property </summary> <param name="invalidation">The value to set for the Invalidation property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateInvalidationResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateInvalidationResult.Invalidation"> <summary> Gets and sets the property Invalidation. The invalidation's information. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateInvalidationResult.Location"> <summary> Gets and sets the property Location. The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateStreamingDistributionRequest"> <summary> Container for the parameters to the CreateStreamingDistribution operation. Create a new streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateStreamingDistributionRequest.WithStreamingDistributionConfig(Amazon.CloudFront.Model.StreamingDistributionConfig)"> <summary> Sets the StreamingDistributionConfig property </summary> <param name="streamingDistributionConfig">The value to set for the StreamingDistributionConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateStreamingDistributionRequest.StreamingDistributionConfig"> <summary> Gets and sets the property StreamingDistributionConfig. The streaming distribution's configuration information. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateStreamingDistributionResponse"> <summary> Returns information about the CreateStreamingDistributionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateStreamingDistributionResponse.CreateStreamingDistributionResult"> <summary> Gets and sets the CreateStreamingDistributionResult property. Represents the output of a CreateStreamingDistribution operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateStreamingDistributionResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateStreamingDistributionResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateStreamingDistributionResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CreateStreamingDistributionResult.WithStreamingDistribution(Amazon.CloudFront.Model.StreamingDistribution)"> <summary> Sets the StreamingDistribution property </summary> <param name="streamingDistribution">The value to set for the StreamingDistribution property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CreateStreamingDistributionResult.ETag"> <summary> Gets and sets the property ETag. The current version of the streaming distribution created. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateStreamingDistributionResult.Location"> <summary> Gets and sets the property Location. The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8. </summary> </member> <member name="P:Amazon.CloudFront.Model.CreateStreamingDistributionResult.StreamingDistribution"> <summary> Gets and sets the property StreamingDistribution. The streaming distribution's information. </summary> </member> <member name="T:Amazon.CloudFront.Model.CustomErrorResponse"> <summary> A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.CustomErrorResponse.WithErrorCachingMinTTL(System.Int64)"> <summary> Sets the ErrorCachingMinTTL property </summary> <param name="errorCachingMinTTL">The value to set for the ErrorCachingMinTTL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CustomErrorResponse.WithErrorCode(System.Int32)"> <summary> Sets the ErrorCode property </summary> <param name="errorCode">The value to set for the ErrorCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CustomErrorResponse.WithResponseCode(System.String)"> <summary> Sets the ResponseCode property </summary> <param name="responseCode">The value to set for the ResponseCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CustomErrorResponse.WithResponsePagePath(System.String)"> <summary> Sets the ResponsePagePath property </summary> <param name="responsePagePath">The value to set for the ResponsePagePath property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CustomErrorResponse.ErrorCachingMinTTL"> <summary> Gets and sets the property ErrorCachingMinTTL. The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000. </summary> </member> <member name="P:Amazon.CloudFront.Model.CustomErrorResponse.ErrorCode"> <summary> Gets and sets the property ErrorCode. The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation. </summary> </member> <member name="P:Amazon.CloudFront.Model.CustomErrorResponse.ResponseCode"> <summary> Gets and sets the property ResponseCode. The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation. </summary> </member> <member name="P:Amazon.CloudFront.Model.CustomErrorResponse.ResponsePagePath"> <summary> Gets and sets the property ResponsePagePath. The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer. </summary> </member> <member name="T:Amazon.CloudFront.Model.CustomErrorResponses"> <summary> A complex type that contains zero or more CustomErrorResponse elements. </summary> </member> <member name="M:Amazon.CloudFront.Model.CustomErrorResponses.WithItems(Amazon.CloudFront.Model.CustomErrorResponse[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CustomErrorResponses.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.CustomErrorResponse})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CustomErrorResponses.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CustomErrorResponses.Items"> <summary> Gets and sets the property Items. Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items. </summary> </member> <member name="P:Amazon.CloudFront.Model.CustomErrorResponses.Quantity"> <summary> Gets and sets the property Quantity. The number of custom error responses for this distribution. </summary> </member> <member name="T:Amazon.CloudFront.Model.CustomOriginConfig"> <summary> A customer origin. </summary> </member> <member name="M:Amazon.CloudFront.Model.CustomOriginConfig.WithHTTPPort(System.Int32)"> <summary> Sets the HTTPPort property </summary> <param name="hTTPPort">The value to set for the HTTPPort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CustomOriginConfig.WithHTTPSPort(System.Int32)"> <summary> Sets the HTTPSPort property </summary> <param name="hTTPSPort">The value to set for the HTTPSPort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.CustomOriginConfig.WithOriginProtocolPolicy(System.String)"> <summary> Sets the OriginProtocolPolicy property </summary> <param name="originProtocolPolicy">The value to set for the OriginProtocolPolicy property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.CustomOriginConfig.HTTPPort"> <summary> Gets and sets the property HTTPPort. The HTTP port the custom origin listens on. </summary> </member> <member name="P:Amazon.CloudFront.Model.CustomOriginConfig.HTTPSPort"> <summary> Gets and sets the property HTTPSPort. The HTTPS port the custom origin listens on. </summary> </member> <member name="P:Amazon.CloudFront.Model.CustomOriginConfig.OriginProtocolPolicy"> <summary> Gets and sets the property OriginProtocolPolicy. The origin protocol policy to apply to your origin. </summary> </member> <member name="T:Amazon.CloudFront.Model.DefaultCacheBehavior"> <summary> A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior. </summary> </member> <member name="M:Amazon.CloudFront.Model.DefaultCacheBehavior.WithAllowedMethods(Amazon.CloudFront.Model.AllowedMethods)"> <summary> Sets the AllowedMethods property </summary> <param name="allowedMethods">The value to set for the AllowedMethods property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DefaultCacheBehavior.WithForwardedValues(Amazon.CloudFront.Model.ForwardedValues)"> <summary> Sets the ForwardedValues property </summary> <param name="forwardedValues">The value to set for the ForwardedValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DefaultCacheBehavior.WithMinTTL(System.Int64)"> <summary> Sets the MinTTL property </summary> <param name="minTTL">The value to set for the MinTTL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DefaultCacheBehavior.WithSmoothStreaming(System.Boolean)"> <summary> Sets the SmoothStreaming property </summary> <param name="smoothStreaming">The value to set for the SmoothStreaming property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DefaultCacheBehavior.WithTargetOriginId(System.String)"> <summary> Sets the TargetOriginId property </summary> <param name="targetOriginId">The value to set for the TargetOriginId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DefaultCacheBehavior.WithTrustedSigners(Amazon.CloudFront.Model.TrustedSigners)"> <summary> Sets the TrustedSigners property </summary> <param name="trustedSigners">The value to set for the TrustedSigners property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DefaultCacheBehavior.WithViewerProtocolPolicy(System.String)"> <summary> Sets the ViewerProtocolPolicy property </summary> <param name="viewerProtocolPolicy">The value to set for the ViewerProtocolPolicy property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.AllowedMethods"> <summary> Gets and sets the property AllowedMethods. </summary> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.ForwardedValues"> <summary> Gets and sets the property ForwardedValues. A complex type that specifies how CloudFront handles query strings, cookies and headers. </summary> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.MinTTL"> <summary> Gets and sets the property MinTTL. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years). </summary> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.SmoothStreaming"> <summary> Gets and sets the property SmoothStreaming. Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. </summary> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.TargetOriginId"> <summary> Gets and sets the property TargetOriginId. The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior. </summary> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.TrustedSigners"> <summary> Gets and sets the property TrustedSigners. A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.ViewerProtocolPolicy"> <summary> Gets and sets the property ViewerProtocolPolicy. Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL. </summary> </member> <member name="T:Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest"> <summary> Container for the parameters to the DeleteCloudFrontOriginAccessIdentity operation. Delete an origin access identity. </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest.WithIfMatch(System.String)"> <summary> Sets the IfMatch property </summary> <param name="ifMatch">The value to set for the IfMatch property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest.Id"> <summary> Gets and sets the property Id. The origin access identity's id. </summary> </member> <member name="P:Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest.IfMatch"> <summary> Gets and sets the property IfMatch. The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityResponse"> <summary> Returns information about the DeleteCloudFrontOriginAccessIdentityResult response and response metadata. </summary> </member> <member name="T:Amazon.CloudFront.Model.DeleteDistributionRequest"> <summary> Container for the parameters to the DeleteDistribution operation. Delete a distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteDistributionRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DeleteDistributionRequest.WithIfMatch(System.String)"> <summary> Sets the IfMatch property </summary> <param name="ifMatch">The value to set for the IfMatch property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.DeleteDistributionRequest.Id"> <summary> Gets and sets the property Id. The distribution id. </summary> </member> <member name="P:Amazon.CloudFront.Model.DeleteDistributionRequest.IfMatch"> <summary> Gets and sets the property IfMatch. The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.DeleteDistributionResponse"> <summary> Returns information about the DeleteDistributionResult response and response metadata. </summary> </member> <member name="T:Amazon.CloudFront.Model.DeleteStreamingDistributionRequest"> <summary> Container for the parameters to the DeleteStreamingDistribution operation. Delete a streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteStreamingDistributionRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DeleteStreamingDistributionRequest.WithIfMatch(System.String)"> <summary> Sets the IfMatch property </summary> <param name="ifMatch">The value to set for the IfMatch property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.DeleteStreamingDistributionRequest.Id"> <summary> Gets and sets the property Id. The distribution id. </summary> </member> <member name="P:Amazon.CloudFront.Model.DeleteStreamingDistributionRequest.IfMatch"> <summary> Gets and sets the property IfMatch. The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.DeleteStreamingDistributionResponse"> <summary> Returns information about the DeleteStreamingDistributionResult response and response metadata. </summary> </member> <member name="T:Amazon.CloudFront.Model.Distribution"> <summary> A distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.Distribution.WithActiveTrustedSigners(Amazon.CloudFront.Model.ActiveTrustedSigners)"> <summary> Sets the ActiveTrustedSigners property </summary> <param name="activeTrustedSigners">The value to set for the ActiveTrustedSigners property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Distribution.WithDistributionConfig(Amazon.CloudFront.Model.DistributionConfig)"> <summary> Sets the DistributionConfig property </summary> <param name="distributionConfig">The value to set for the DistributionConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Distribution.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Distribution.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Distribution.WithInProgressInvalidationBatches(System.Int32)"> <summary> Sets the InProgressInvalidationBatches property </summary> <param name="inProgressInvalidationBatches">The value to set for the InProgressInvalidationBatches property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Distribution.WithLastModifiedTime(System.DateTime)"> <summary> Sets the LastModifiedTime property </summary> <param name="lastModifiedTime">The value to set for the LastModifiedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Distribution.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Distribution.ActiveTrustedSigners"> <summary> Gets and sets the property ActiveTrustedSigners. CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs. </summary> </member> <member name="P:Amazon.CloudFront.Model.Distribution.DistributionConfig"> <summary> Gets and sets the property DistributionConfig. The current configuration information for the distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.Distribution.DomainName"> <summary> Gets and sets the property DomainName. The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net. </summary> </member> <member name="P:Amazon.CloudFront.Model.Distribution.Id"> <summary> Gets and sets the property Id. The identifier for the distribution. For example: EDFDVBD632BHDS5. </summary> </member> <member name="P:Amazon.CloudFront.Model.Distribution.InProgressInvalidationBatches"> <summary> Gets and sets the property InProgressInvalidationBatches. The number of invalidation batches currently in progress. </summary> </member> <member name="P:Amazon.CloudFront.Model.Distribution.LastModifiedTime"> <summary> Gets and sets the property LastModifiedTime. The date and time the distribution was last modified. </summary> </member> <member name="P:Amazon.CloudFront.Model.Distribution.Status"> <summary> Gets and sets the property Status. This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system. </summary> </member> <member name="T:Amazon.CloudFront.Model.DistributionAlreadyExistsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.DistributionAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new DistributionAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.DistributionConfig"> <summary> A distribution Configuration. </summary> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithAliases(Amazon.CloudFront.Model.Aliases)"> <summary> Sets the Aliases property </summary> <param name="aliases">The value to set for the Aliases property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithCacheBehaviors(Amazon.CloudFront.Model.CacheBehaviors)"> <summary> Sets the CacheBehaviors property </summary> <param name="cacheBehaviors">The value to set for the CacheBehaviors property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithCallerReference(System.String)"> <summary> Sets the CallerReference property </summary> <param name="callerReference">The value to set for the CallerReference property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithComment(System.String)"> <summary> Sets the Comment property </summary> <param name="comment">The value to set for the Comment property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithCustomErrorResponses(Amazon.CloudFront.Model.CustomErrorResponses)"> <summary> Sets the CustomErrorResponses property </summary> <param name="customErrorResponses">The value to set for the CustomErrorResponses property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithDefaultCacheBehavior(Amazon.CloudFront.Model.DefaultCacheBehavior)"> <summary> Sets the DefaultCacheBehavior property </summary> <param name="defaultCacheBehavior">The value to set for the DefaultCacheBehavior property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithDefaultRootObject(System.String)"> <summary> Sets the DefaultRootObject property </summary> <param name="defaultRootObject">The value to set for the DefaultRootObject property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithLogging(Amazon.CloudFront.Model.LoggingConfig)"> <summary> Sets the Logging property </summary> <param name="logging">The value to set for the Logging property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithOrigins(Amazon.CloudFront.Model.Origins)"> <summary> Sets the Origins property </summary> <param name="origins">The value to set for the Origins property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithPriceClass(System.String)"> <summary> Sets the PriceClass property </summary> <param name="priceClass">The value to set for the PriceClass property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithRestrictions(Amazon.CloudFront.Model.Restrictions)"> <summary> Sets the Restrictions property </summary> <param name="restrictions">The value to set for the Restrictions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.WithViewerCertificate(Amazon.CloudFront.Model.ViewerCertificate)"> <summary> Sets the ViewerCertificate property </summary> <param name="viewerCertificate">The value to set for the ViewerCertificate property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.Aliases"> <summary> Gets and sets the property Aliases. A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.CacheBehaviors"> <summary> Gets and sets the property CacheBehaviors. A complex type that contains zero or more CacheBehavior elements. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.CallerReference"> <summary> Gets and sets the property CallerReference. A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.Comment"> <summary> Gets and sets the property Comment. Any comments you want to include about the distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.CustomErrorResponses"> <summary> Gets and sets the property CustomErrorResponses. A complex type that contains zero or more CustomErrorResponse elements. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.DefaultCacheBehavior"> <summary> Gets and sets the property DefaultCacheBehavior. A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.DefaultRootObject"> <summary> Gets and sets the property DefaultRootObject. The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.Enabled"> <summary> Gets and sets the property Enabled. Whether the distribution is enabled to accept end user requests for content. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.Logging"> <summary> Gets and sets the property Logging. A complex type that controls whether access logs are written for the distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.Origins"> <summary> Gets and sets the property Origins. A complex type that contains information about origins for this distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.PriceClass"> <summary> Gets and sets the property PriceClass. A complex type that contains information about price class for this distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.Restrictions"> <summary> Gets and sets the property Restrictions. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionConfig.ViewerCertificate"> <summary> Gets and sets the property ViewerCertificate. </summary> </member> <member name="T:Amazon.CloudFront.Model.DistributionList"> <summary> A distribution list. </summary> </member> <member name="M:Amazon.CloudFront.Model.DistributionList.WithIsTruncated(System.Boolean)"> <summary> Sets the IsTruncated property </summary> <param name="isTruncated">The value to set for the IsTruncated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionList.WithItems(Amazon.CloudFront.Model.DistributionSummary[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionList.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.DistributionSummary})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionList.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionList.WithMaxItems(System.Int32)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionList.WithNextMarker(System.String)"> <summary> Sets the NextMarker property </summary> <param name="nextMarker">The value to set for the NextMarker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionList.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.DistributionList.IsTruncated"> <summary> Gets and sets the property IsTruncated. A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionList.Items"> <summary> Gets and sets the property Items. A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionList.Marker"> <summary> Gets and sets the property Marker. The value you provided for the Marker request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionList.MaxItems"> <summary> Gets and sets the property MaxItems. The value you provided for the MaxItems request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionList.NextMarker"> <summary> Gets and sets the property NextMarker. If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionList.Quantity"> <summary> Gets and sets the property Quantity. The number of distributions that were created by the current AWS account. </summary> </member> <member name="T:Amazon.CloudFront.Model.DistributionNotDisabledException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.DistributionNotDisabledException.#ctor(System.String)"> <summary> Constructs a new DistributionNotDisabledException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.DistributionSummary"> <summary> A summary of the information for an Amazon CloudFront distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithAliases(Amazon.CloudFront.Model.Aliases)"> <summary> Sets the Aliases property </summary> <param name="aliases">The value to set for the Aliases property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithCacheBehaviors(Amazon.CloudFront.Model.CacheBehaviors)"> <summary> Sets the CacheBehaviors property </summary> <param name="cacheBehaviors">The value to set for the CacheBehaviors property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithComment(System.String)"> <summary> Sets the Comment property </summary> <param name="comment">The value to set for the Comment property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithCustomErrorResponses(Amazon.CloudFront.Model.CustomErrorResponses)"> <summary> Sets the CustomErrorResponses property </summary> <param name="customErrorResponses">The value to set for the CustomErrorResponses property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithDefaultCacheBehavior(Amazon.CloudFront.Model.DefaultCacheBehavior)"> <summary> Sets the DefaultCacheBehavior property </summary> <param name="defaultCacheBehavior">The value to set for the DefaultCacheBehavior property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithLastModifiedTime(System.DateTime)"> <summary> Sets the LastModifiedTime property </summary> <param name="lastModifiedTime">The value to set for the LastModifiedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithOrigins(Amazon.CloudFront.Model.Origins)"> <summary> Sets the Origins property </summary> <param name="origins">The value to set for the Origins property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithPriceClass(System.String)"> <summary> Sets the PriceClass property </summary> <param name="priceClass">The value to set for the PriceClass property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithRestrictions(Amazon.CloudFront.Model.Restrictions)"> <summary> Sets the Restrictions property </summary> <param name="restrictions">The value to set for the Restrictions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.DistributionSummary.WithViewerCertificate(Amazon.CloudFront.Model.ViewerCertificate)"> <summary> Sets the ViewerCertificate property </summary> <param name="viewerCertificate">The value to set for the ViewerCertificate property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.Aliases"> <summary> Gets and sets the property Aliases. A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.CacheBehaviors"> <summary> Gets and sets the property CacheBehaviors. A complex type that contains zero or more CacheBehavior elements. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.Comment"> <summary> Gets and sets the property Comment. The comment originally specified when this distribution was created. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.CustomErrorResponses"> <summary> Gets and sets the property CustomErrorResponses. A complex type that contains zero or more CustomErrorResponses elements. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.DefaultCacheBehavior"> <summary> Gets and sets the property DefaultCacheBehavior. A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.DomainName"> <summary> Gets and sets the property DomainName. The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.Enabled"> <summary> Gets and sets the property Enabled. Whether the distribution is enabled to accept end user requests for content. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.Id"> <summary> Gets and sets the property Id. The identifier for the distribution. For example: EDFDVBD632BHDS5. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.LastModifiedTime"> <summary> Gets and sets the property LastModifiedTime. The date and time the distribution was last modified. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.Origins"> <summary> Gets and sets the property Origins. A complex type that contains information about origins for this distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.PriceClass"> <summary> Gets and sets the property PriceClass. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.Restrictions"> <summary> Gets and sets the property Restrictions. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.Status"> <summary> Gets and sets the property Status. This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system. </summary> </member> <member name="P:Amazon.CloudFront.Model.DistributionSummary.ViewerCertificate"> <summary> Gets and sets the property ViewerCertificate. </summary> </member> <member name="T:Amazon.CloudFront.Model.ForwardedValues"> <summary> A complex type that specifies how CloudFront handles query strings, cookies and headers. </summary> </member> <member name="M:Amazon.CloudFront.Model.ForwardedValues.WithCookies(Amazon.CloudFront.Model.CookiePreference)"> <summary> Sets the Cookies property </summary> <param name="cookies">The value to set for the Cookies property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ForwardedValues.WithHeaders(Amazon.CloudFront.Model.Headers)"> <summary> Sets the Headers property </summary> <param name="headers">The value to set for the Headers property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ForwardedValues.WithQueryString(System.Boolean)"> <summary> Sets the QueryString property </summary> <param name="queryString">The value to set for the QueryString property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ForwardedValues.Cookies"> <summary> Gets and sets the property Cookies. A complex type that specifies how CloudFront handles cookies. </summary> </member> <member name="P:Amazon.CloudFront.Model.ForwardedValues.Headers"> <summary> Gets and sets the property Headers. A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior. </summary> </member> <member name="P:Amazon.CloudFront.Model.ForwardedValues.QueryString"> <summary> Gets and sets the property QueryString. Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false. </summary> </member> <member name="T:Amazon.CloudFront.Model.GeoRestriction"> <summary> A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website. </summary> </member> <member name="M:Amazon.CloudFront.Model.GeoRestriction.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GeoRestriction.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GeoRestriction.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GeoRestriction.WithRestrictionType(System.String)"> <summary> Sets the RestrictionType property </summary> <param name="restrictionType">The value to set for the RestrictionType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GeoRestriction.Items"> <summary> Gets and sets the property Items. A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes. </summary> </member> <member name="P:Amazon.CloudFront.Model.GeoRestriction.Quantity"> <summary> Gets and sets the property Quantity. When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items. </summary> </member> <member name="P:Amazon.CloudFront.Model.GeoRestriction.RestrictionType"> <summary> Gets and sets the property RestrictionType. The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest"> <summary> Container for the parameters to the GetCloudFrontOriginAccessIdentityConfig operation. Get the configuration information about an origin access identity. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest.Id"> <summary> Gets and sets the property Id. The identity's id. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResponse"> <summary> Returns information about the GetCloudFrontOriginAccessIdentityConfigResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResponse.GetCloudFrontOriginAccessIdentityConfigResult"> <summary> Gets and sets the GetCloudFrontOriginAccessIdentityConfigResult property. Represents the output of a GetCloudFrontOriginAccessIdentityConfig operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResult.WithCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Sets the CloudFrontOriginAccessIdentityConfig property </summary> <param name="cloudFrontOriginAccessIdentityConfig">The value to set for the CloudFrontOriginAccessIdentityConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResult.CloudFrontOriginAccessIdentityConfig"> <summary> Gets and sets the property CloudFrontOriginAccessIdentityConfig. The origin access identity's configuration information. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResult.ETag"> <summary> Gets and sets the property ETag. The current version of the configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest"> <summary> Container for the parameters to the GetCloudFrontOriginAccessIdentity operation. Get the information about an origin access identity. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest.Id"> <summary> Gets and sets the property Id. The identity's id. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResponse"> <summary> Returns information about the GetCloudFrontOriginAccessIdentityResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResponse.GetCloudFrontOriginAccessIdentityResult"> <summary> Gets and sets the GetCloudFrontOriginAccessIdentityResult property. Represents the output of a GetCloudFrontOriginAccessIdentity operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResult.WithCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity)"> <summary> Sets the CloudFrontOriginAccessIdentity property </summary> <param name="cloudFrontOriginAccessIdentity">The value to set for the CloudFrontOriginAccessIdentity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResult.CloudFrontOriginAccessIdentity"> <summary> Gets and sets the property CloudFrontOriginAccessIdentity. The origin access identity's information. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResult.ETag"> <summary> Gets and sets the property ETag. The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionConfigRequest"> <summary> Container for the parameters to the GetDistributionConfig operation. Get the configuration information about a distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionConfigRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionConfigRequest.Id"> <summary> Gets and sets the property Id. The distribution's id. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionConfigResponse"> <summary> Returns information about the GetDistributionConfigResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionConfigResponse.GetDistributionConfigResult"> <summary> Gets and sets the GetDistributionConfigResult property. Represents the output of a GetDistributionConfig operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionConfigResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionConfigResult.WithDistributionConfig(Amazon.CloudFront.Model.DistributionConfig)"> <summary> Sets the DistributionConfig property </summary> <param name="distributionConfig">The value to set for the DistributionConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionConfigResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionConfigResult.DistributionConfig"> <summary> Gets and sets the property DistributionConfig. The distribution's configuration information. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionConfigResult.ETag"> <summary> Gets and sets the property ETag. The current version of the configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionRequest"> <summary> Container for the parameters to the GetDistribution operation. Get the information about a distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionRequest.Id"> <summary> Gets and sets the property Id. The distribution's id. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionResponse"> <summary> Returns information about the GetDistributionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionResponse.GetDistributionResult"> <summary> Gets and sets the GetDistributionResult property. Represents the output of a GetDistribution operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionResult.WithDistribution(Amazon.CloudFront.Model.Distribution)"> <summary> Sets the Distribution property </summary> <param name="distribution">The value to set for the Distribution property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionResult.Distribution"> <summary> Gets and sets the property Distribution. The distribution's information. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetDistributionResult.ETag"> <summary> Gets and sets the property ETag. The current version of the distribution's information. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetInvalidationRequest"> <summary> Container for the parameters to the GetInvalidation operation. Get the information about an invalidation. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetInvalidationRequest.WithDistributionId(System.String)"> <summary> Sets the DistributionId property </summary> <param name="distributionId">The value to set for the DistributionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GetInvalidationRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetInvalidationRequest.DistributionId"> <summary> Gets and sets the property DistributionId. The distribution's id. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetInvalidationRequest.Id"> <summary> Gets and sets the property Id. The invalidation's id. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetInvalidationResponse"> <summary> Returns information about the GetInvalidationResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetInvalidationResponse.GetInvalidationResult"> <summary> Gets and sets the GetInvalidationResult property. Represents the output of a GetInvalidation operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetInvalidationResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetInvalidationResult.WithInvalidation(Amazon.CloudFront.Model.Invalidation)"> <summary> Sets the Invalidation property </summary> <param name="invalidation">The value to set for the Invalidation property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetInvalidationResult.Invalidation"> <summary> Gets and sets the property Invalidation. The invalidation's information. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest"> <summary> Container for the parameters to the GetStreamingDistributionConfig operation. Get the configuration information about a streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest.Id"> <summary> Gets and sets the property Id. The streaming distribution's id. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionConfigResponse"> <summary> Returns information about the GetStreamingDistributionConfigResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionConfigResponse.GetStreamingDistributionConfigResult"> <summary> Gets and sets the GetStreamingDistributionConfigResult property. Represents the output of a GetStreamingDistributionConfig operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionConfigResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionConfigResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionConfigResult.WithStreamingDistributionConfig(Amazon.CloudFront.Model.StreamingDistributionConfig)"> <summary> Sets the StreamingDistributionConfig property </summary> <param name="streamingDistributionConfig">The value to set for the StreamingDistributionConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionConfigResult.ETag"> <summary> Gets and sets the property ETag. The current version of the configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionConfigResult.StreamingDistributionConfig"> <summary> Gets and sets the property StreamingDistributionConfig. The streaming distribution's configuration information. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionRequest"> <summary> Container for the parameters to the GetStreamingDistribution operation. Get the information about a streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionRequest.Id"> <summary> Gets and sets the property Id. The streaming distribution's id. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionResponse"> <summary> Returns information about the GetStreamingDistributionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionResponse.GetStreamingDistributionResult"> <summary> Gets and sets the GetStreamingDistributionResult property. Represents the output of a GetStreamingDistribution operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionResult.WithStreamingDistribution(Amazon.CloudFront.Model.StreamingDistribution)"> <summary> Sets the StreamingDistribution property </summary> <param name="streamingDistribution">The value to set for the StreamingDistribution property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionResult.ETag"> <summary> Gets and sets the property ETag. The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetStreamingDistributionResult.StreamingDistribution"> <summary> Gets and sets the property StreamingDistribution. The streaming distribution's information. </summary> </member> <member name="T:Amazon.CloudFront.Model.Headers"> <summary> A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value. </summary> </member> <member name="M:Amazon.CloudFront.Model.Headers.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Headers.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Headers.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Headers.Items"> <summary> Gets and sets the property Items. Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items. </summary> </member> <member name="P:Amazon.CloudFront.Model.Headers.Quantity"> <summary> Gets and sets the property Quantity. The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items. </summary> </member> <member name="T:Amazon.CloudFront.Model.IllegalUpdateException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.IllegalUpdateException.#ctor(System.String)"> <summary> Constructs a new IllegalUpdateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InconsistentQuantitiesException.#ctor(System.String)"> <summary> Constructs a new InconsistentQuantitiesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ActiveTrustedSignersUnmarshaller"> <summary> Response Unmarshaller for ActiveTrustedSigners Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.AliasesUnmarshaller"> <summary> Response Unmarshaller for Aliases Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.AllowedMethodsUnmarshaller"> <summary> Response Unmarshaller for AllowedMethods Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CacheBehaviorsUnmarshaller"> <summary> Response Unmarshaller for CacheBehaviors Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CacheBehaviorUnmarshaller"> <summary> Response Unmarshaller for CacheBehavior Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CloudFrontOriginAccessIdentityConfigUnmarshaller"> <summary> Response Unmarshaller for CloudFrontOriginAccessIdentityConfig Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CloudFrontOriginAccessIdentityListUnmarshaller"> <summary> Response Unmarshaller for CloudFrontOriginAccessIdentityList Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CloudFrontOriginAccessIdentitySummaryUnmarshaller"> <summary> Response Unmarshaller for CloudFrontOriginAccessIdentitySummary Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CloudFrontOriginAccessIdentityUnmarshaller"> <summary> Response Unmarshaller for CloudFrontOriginAccessIdentity Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CookieNamesUnmarshaller"> <summary> Response Unmarshaller for CookieNames Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CookiePreferenceUnmarshaller"> <summary> Response Unmarshaller for CookiePreference Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateCloudFrontOriginAccessIdentityRequestMarshaller"> <summary> CreateCloudFrontOriginAccessIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateCloudFrontOriginAccessIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCloudFrontOriginAccessIdentity operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateCloudFrontOriginAccessIdentityResultUnmarshaller"> <summary> Result Unmarshaller for CreateCloudFrontOriginAccessIdentity operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateDistributionRequestMarshaller"> <summary> CreateDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateDistributionResultUnmarshaller"> <summary> Result Unmarshaller for CreateDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateInvalidationRequestMarshaller"> <summary> CreateInvalidation Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateInvalidationResponseUnmarshaller"> <summary> Response Unmarshaller for CreateInvalidation operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateInvalidationResultUnmarshaller"> <summary> Result Unmarshaller for CreateInvalidation operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateStreamingDistributionRequestMarshaller"> <summary> CreateStreamingDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateStreamingDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for CreateStreamingDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CreateStreamingDistributionResultUnmarshaller"> <summary> Result Unmarshaller for CreateStreamingDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CustomErrorResponsesUnmarshaller"> <summary> Response Unmarshaller for CustomErrorResponses Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CustomErrorResponseUnmarshaller"> <summary> Response Unmarshaller for CustomErrorResponse Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.CustomOriginConfigUnmarshaller"> <summary> Response Unmarshaller for CustomOriginConfig Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DefaultCacheBehaviorUnmarshaller"> <summary> Response Unmarshaller for DefaultCacheBehavior Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DeleteCloudFrontOriginAccessIdentityRequestMarshaller"> <summary> DeleteCloudFrontOriginAccessIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DeleteCloudFrontOriginAccessIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteCloudFrontOriginAccessIdentity operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DeleteDistributionRequestMarshaller"> <summary> DeleteDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DeleteDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DeleteStreamingDistributionRequestMarshaller"> <summary> DeleteStreamingDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DeleteStreamingDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteStreamingDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DistributionConfigUnmarshaller"> <summary> Response Unmarshaller for DistributionConfig Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DistributionListUnmarshaller"> <summary> Response Unmarshaller for DistributionList Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DistributionSummaryUnmarshaller"> <summary> Response Unmarshaller for DistributionSummary Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.DistributionUnmarshaller"> <summary> Response Unmarshaller for Distribution Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ForwardedValuesUnmarshaller"> <summary> Response Unmarshaller for ForwardedValues Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GeoRestrictionUnmarshaller"> <summary> Response Unmarshaller for GeoRestriction Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetCloudFrontOriginAccessIdentityConfigRequestMarshaller"> <summary> GetCloudFrontOriginAccessIdentityConfig Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetCloudFrontOriginAccessIdentityConfigResponseUnmarshaller"> <summary> Response Unmarshaller for GetCloudFrontOriginAccessIdentityConfig operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetCloudFrontOriginAccessIdentityConfigResultUnmarshaller"> <summary> Result Unmarshaller for GetCloudFrontOriginAccessIdentityConfig operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetCloudFrontOriginAccessIdentityRequestMarshaller"> <summary> GetCloudFrontOriginAccessIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetCloudFrontOriginAccessIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for GetCloudFrontOriginAccessIdentity operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetCloudFrontOriginAccessIdentityResultUnmarshaller"> <summary> Result Unmarshaller for GetCloudFrontOriginAccessIdentity operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetDistributionConfigRequestMarshaller"> <summary> GetDistributionConfig Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetDistributionConfigResponseUnmarshaller"> <summary> Response Unmarshaller for GetDistributionConfig operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetDistributionConfigResultUnmarshaller"> <summary> Result Unmarshaller for GetDistributionConfig operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetDistributionRequestMarshaller"> <summary> GetDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for GetDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetDistributionResultUnmarshaller"> <summary> Result Unmarshaller for GetDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetInvalidationRequestMarshaller"> <summary> GetInvalidation Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetInvalidationResponseUnmarshaller"> <summary> Response Unmarshaller for GetInvalidation operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetInvalidationResultUnmarshaller"> <summary> Result Unmarshaller for GetInvalidation operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetStreamingDistributionConfigRequestMarshaller"> <summary> GetStreamingDistributionConfig Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetStreamingDistributionConfigResponseUnmarshaller"> <summary> Response Unmarshaller for GetStreamingDistributionConfig operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetStreamingDistributionConfigResultUnmarshaller"> <summary> Result Unmarshaller for GetStreamingDistributionConfig operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetStreamingDistributionRequestMarshaller"> <summary> GetStreamingDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetStreamingDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for GetStreamingDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.GetStreamingDistributionResultUnmarshaller"> <summary> Result Unmarshaller for GetStreamingDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.HeadersUnmarshaller"> <summary> Response Unmarshaller for Headers Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.InvalidationBatchUnmarshaller"> <summary> Response Unmarshaller for InvalidationBatch Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.InvalidationListUnmarshaller"> <summary> Response Unmarshaller for InvalidationList Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.InvalidationSummaryUnmarshaller"> <summary> Response Unmarshaller for InvalidationSummary Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.InvalidationUnmarshaller"> <summary> Response Unmarshaller for Invalidation Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.KeyPairIdsUnmarshaller"> <summary> Response Unmarshaller for KeyPairIds Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListCloudFrontOriginAccessIdentitiesRequestMarshaller"> <summary> ListCloudFrontOriginAccessIdentities Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListCloudFrontOriginAccessIdentitiesResponseUnmarshaller"> <summary> Response Unmarshaller for ListCloudFrontOriginAccessIdentities operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListCloudFrontOriginAccessIdentitiesResultUnmarshaller"> <summary> Result Unmarshaller for ListCloudFrontOriginAccessIdentities operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListDistributionsRequestMarshaller"> <summary> ListDistributions Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListDistributionsResponseUnmarshaller"> <summary> Response Unmarshaller for ListDistributions operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListDistributionsResultUnmarshaller"> <summary> Result Unmarshaller for ListDistributions operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListInvalidationsRequestMarshaller"> <summary> ListInvalidations Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListInvalidationsResponseUnmarshaller"> <summary> Response Unmarshaller for ListInvalidations operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListInvalidationsResultUnmarshaller"> <summary> Result Unmarshaller for ListInvalidations operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListStreamingDistributionsRequestMarshaller"> <summary> ListStreamingDistributions Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListStreamingDistributionsResponseUnmarshaller"> <summary> Response Unmarshaller for ListStreamingDistributions operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ListStreamingDistributionsResultUnmarshaller"> <summary> Result Unmarshaller for ListStreamingDistributions operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.LoggingConfigUnmarshaller"> <summary> Response Unmarshaller for LoggingConfig Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.OriginsUnmarshaller"> <summary> Response Unmarshaller for Origins Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.OriginUnmarshaller"> <summary> Response Unmarshaller for Origin Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.PathsUnmarshaller"> <summary> Response Unmarshaller for Paths Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.RestrictionsUnmarshaller"> <summary> Response Unmarshaller for Restrictions Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.S3OriginConfigUnmarshaller"> <summary> Response Unmarshaller for S3OriginConfig Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.S3OriginUnmarshaller"> <summary> Response Unmarshaller for S3Origin Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.SignerUnmarshaller"> <summary> Response Unmarshaller for Signer Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.StreamingDistributionConfigUnmarshaller"> <summary> Response Unmarshaller for StreamingDistributionConfig Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.StreamingDistributionListUnmarshaller"> <summary> Response Unmarshaller for StreamingDistributionList Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.StreamingDistributionSummaryUnmarshaller"> <summary> Response Unmarshaller for StreamingDistributionSummary Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.StreamingDistributionUnmarshaller"> <summary> Response Unmarshaller for StreamingDistribution Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.StreamingLoggingConfigUnmarshaller"> <summary> Response Unmarshaller for StreamingLoggingConfig Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.TrustedSignersUnmarshaller"> <summary> Response Unmarshaller for TrustedSigners Object </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateCloudFrontOriginAccessIdentityRequestMarshaller"> <summary> UpdateCloudFrontOriginAccessIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateCloudFrontOriginAccessIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateCloudFrontOriginAccessIdentity operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateCloudFrontOriginAccessIdentityResultUnmarshaller"> <summary> Result Unmarshaller for UpdateCloudFrontOriginAccessIdentity operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateDistributionRequestMarshaller"> <summary> UpdateDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateDistributionResultUnmarshaller"> <summary> Result Unmarshaller for UpdateDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateStreamingDistributionRequestMarshaller"> <summary> UpdateStreamingDistribution Request Marshaller </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateStreamingDistributionResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateStreamingDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.UpdateStreamingDistributionResultUnmarshaller"> <summary> Result Unmarshaller for UpdateStreamingDistribution operation </summary> </member> <member name="T:Amazon.CloudFront.Model.Internal.MarshallTransformations.ViewerCertificateUnmarshaller"> <summary> Response Unmarshaller for ViewerCertificate Object </summary> </member> <member name="T:Amazon.CloudFront.Model.InvalidArgumentException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidArgumentException.#ctor(System.String)"> <summary> Constructs a new InvalidArgumentException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.Invalidation"> <summary> An invalidation. </summary> </member> <member name="M:Amazon.CloudFront.Model.Invalidation.WithCreateTime(System.DateTime)"> <summary> Sets the CreateTime property </summary> <param name="createTime">The value to set for the CreateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Invalidation.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Invalidation.WithInvalidationBatch(Amazon.CloudFront.Model.InvalidationBatch)"> <summary> Sets the InvalidationBatch property </summary> <param name="invalidationBatch">The value to set for the InvalidationBatch property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Invalidation.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Invalidation.CreateTime"> <summary> Gets and sets the property CreateTime. The date and time the invalidation request was first made. </summary> </member> <member name="P:Amazon.CloudFront.Model.Invalidation.Id"> <summary> Gets and sets the property Id. The identifier for the invalidation request. For example: IDFDVBD632BHDS5. </summary> </member> <member name="P:Amazon.CloudFront.Model.Invalidation.InvalidationBatch"> <summary> Gets and sets the property InvalidationBatch. The current invalidation information for the batch request. </summary> </member> <member name="P:Amazon.CloudFront.Model.Invalidation.Status"> <summary> Gets and sets the property Status. The status of the invalidation request. When the invalidation batch is finished, the status is Completed. </summary> </member> <member name="T:Amazon.CloudFront.Model.InvalidationBatch"> <summary> An invalidation batch. </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidationBatch.WithCallerReference(System.String)"> <summary> Sets the CallerReference property </summary> <param name="callerReference">The value to set for the CallerReference property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationBatch.WithPaths(Amazon.CloudFront.Model.Paths)"> <summary> Sets the Paths property </summary> <param name="paths">The value to set for the Paths property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.InvalidationBatch.CallerReference"> <summary> Gets and sets the property CallerReference. A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationBatch.Paths"> <summary> Gets and sets the property Paths. The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object. </summary> </member> <member name="T:Amazon.CloudFront.Model.InvalidationList"> <summary> An invalidation list. </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidationList.WithIsTruncated(System.Boolean)"> <summary> Sets the IsTruncated property </summary> <param name="isTruncated">The value to set for the IsTruncated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationList.WithItems(Amazon.CloudFront.Model.InvalidationSummary[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationList.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.InvalidationSummary})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationList.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationList.WithMaxItems(System.Int32)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationList.WithNextMarker(System.String)"> <summary> Sets the NextMarker property </summary> <param name="nextMarker">The value to set for the NextMarker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationList.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.InvalidationList.IsTruncated"> <summary> Gets and sets the property IsTruncated. A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationList.Items"> <summary> Gets and sets the property Items. A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationList.Marker"> <summary> Gets and sets the property Marker. The value you provided for the Marker request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationList.MaxItems"> <summary> Gets and sets the property MaxItems. The value you provided for the MaxItems request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationList.NextMarker"> <summary> Gets and sets the property NextMarker. If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationList.Quantity"> <summary> Gets and sets the property Quantity. The number of invalidation batches that were created by the current AWS account. </summary> </member> <member name="T:Amazon.CloudFront.Model.InvalidationSummary"> <summary> Summary of an invalidation request. </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidationSummary.WithCreateTime(System.DateTime)"> <summary> Sets the CreateTime property </summary> <param name="createTime">The value to set for the CreateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationSummary.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.InvalidationSummary.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.InvalidationSummary.CreateTime"> <summary> Gets and sets the property CreateTime. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationSummary.Id"> <summary> Gets and sets the property Id. The unique ID for an invalidation request. </summary> </member> <member name="P:Amazon.CloudFront.Model.InvalidationSummary.Status"> <summary> Gets and sets the property Status. The status of an invalidation request. </summary> </member> <member name="T:Amazon.CloudFront.Model.InvalidDefaultRootObjectException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidDefaultRootObjectException.#ctor(System.String)"> <summary> Constructs a new InvalidDefaultRootObjectException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidErrorCodeException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidErrorCodeException.#ctor(System.String)"> <summary> Constructs a new InvalidErrorCodeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidForwardCookiesException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidForwardCookiesException.#ctor(System.String)"> <summary> Constructs a new InvalidForwardCookiesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException.#ctor(System.String)"> <summary> Constructs a new InvalidGeoRestrictionParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException.#ctor(System.String)"> <summary> Constructs a new InvalidHeadersForS3OriginException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidIfMatchVersionException.#ctor(System.String)"> <summary> Constructs a new InvalidIfMatchVersionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidLocationCodeException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidLocationCodeException.#ctor(System.String)"> <summary> Constructs a new InvalidLocationCodeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException.#ctor(System.String)"> <summary> Constructs a new InvalidOriginAccessIdentityException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidOriginException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidOriginException.#ctor(System.String)"> <summary> Constructs a new InvalidOriginException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidRelativePathException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidRelativePathException.#ctor(System.String)"> <summary> Constructs a new InvalidRelativePathException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidRequiredProtocolException.#ctor(System.String)"> <summary> Constructs a new InvalidRequiredProtocolException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidResponseCodeException.#ctor(System.String)"> <summary> Constructs a new InvalidResponseCodeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidViewerCertificateException.#ctor(System.String)"> <summary> Constructs a new InvalidViewerCertificateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.KeyPairIds"> <summary> A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber. </summary> </member> <member name="M:Amazon.CloudFront.Model.KeyPairIds.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.KeyPairIds.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.KeyPairIds.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.KeyPairIds.Items"> <summary> Gets and sets the property Items. A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber. </summary> </member> <member name="P:Amazon.CloudFront.Model.KeyPairIds.Quantity"> <summary> Gets and sets the property Quantity. The number of active CloudFront key pairs for AwsAccountNumber. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest"> <summary> Container for the parameters to the ListCloudFrontOriginAccessIdentities operation. List origin access identities. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest.WithMaxItems(System.String)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest.Marker"> <summary> Gets and sets the property Marker. Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page). </summary> </member> <member name="P:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest.MaxItems"> <summary> Gets and sets the property MaxItems. The maximum number of origin access identities you want in the response body. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResponse"> <summary> Returns information about the ListCloudFrontOriginAccessIdentitiesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResponse.ListCloudFrontOriginAccessIdentitiesResult"> <summary> Gets and sets the ListCloudFrontOriginAccessIdentitiesResult property. Represents the output of a ListCloudFrontOriginAccessIdentities operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResult.WithCloudFrontOriginAccessIdentityList(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityList)"> <summary> Sets the CloudFrontOriginAccessIdentityList property </summary> <param name="cloudFrontOriginAccessIdentityList">The value to set for the CloudFrontOriginAccessIdentityList property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResult.CloudFrontOriginAccessIdentityList"> <summary> Gets and sets the property CloudFrontOriginAccessIdentityList. The CloudFrontOriginAccessIdentityList type. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListDistributionsRequest"> <summary> Container for the parameters to the ListDistributions operation. List distributions. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListDistributionsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ListDistributionsRequest.WithMaxItems(System.String)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListDistributionsRequest.Marker"> <summary> Gets and sets the property Marker. Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page). </summary> </member> <member name="P:Amazon.CloudFront.Model.ListDistributionsRequest.MaxItems"> <summary> Gets and sets the property MaxItems. The maximum number of distributions you want in the response body. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListDistributionsResponse"> <summary> Returns information about the ListDistributionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListDistributionsResponse.ListDistributionsResult"> <summary> Gets and sets the ListDistributionsResult property. Represents the output of a ListDistributions operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListDistributionsResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListDistributionsResult.WithDistributionList(Amazon.CloudFront.Model.DistributionList)"> <summary> Sets the DistributionList property </summary> <param name="distributionList">The value to set for the DistributionList property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListDistributionsResult.DistributionList"> <summary> Gets and sets the property DistributionList. The DistributionList type. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListInvalidationsRequest"> <summary> Container for the parameters to the ListInvalidations operation. List invalidation batches. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListInvalidationsRequest.WithDistributionId(System.String)"> <summary> Sets the DistributionId property </summary> <param name="distributionId">The value to set for the DistributionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ListInvalidationsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ListInvalidationsRequest.WithMaxItems(System.String)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListInvalidationsRequest.DistributionId"> <summary> Gets and sets the property DistributionId. The distribution's id. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListInvalidationsRequest.Marker"> <summary> Gets and sets the property Marker. Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListInvalidationsRequest.MaxItems"> <summary> Gets and sets the property MaxItems. The maximum number of invalidation batches you want in the response body. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListInvalidationsResponse"> <summary> Returns information about the ListInvalidationsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListInvalidationsResponse.ListInvalidationsResult"> <summary> Gets and sets the ListInvalidationsResult property. Represents the output of a ListInvalidations operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListInvalidationsResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListInvalidationsResult.WithInvalidationList(Amazon.CloudFront.Model.InvalidationList)"> <summary> Sets the InvalidationList property </summary> <param name="invalidationList">The value to set for the InvalidationList property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListInvalidationsResult.InvalidationList"> <summary> Gets and sets the property InvalidationList. Information about invalidation batches. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListStreamingDistributionsRequest"> <summary> Container for the parameters to the ListStreamingDistributions operation. List streaming distributions. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListStreamingDistributionsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ListStreamingDistributionsRequest.WithMaxItems(System.String)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListStreamingDistributionsRequest.Marker"> <summary> Gets and sets the property Marker. Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page). </summary> </member> <member name="P:Amazon.CloudFront.Model.ListStreamingDistributionsRequest.MaxItems"> <summary> Gets and sets the property MaxItems. The maximum number of streaming distributions you want in the response body. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListStreamingDistributionsResponse"> <summary> Returns information about the ListStreamingDistributionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListStreamingDistributionsResponse.ListStreamingDistributionsResult"> <summary> Gets and sets the ListStreamingDistributionsResult property. Represents the output of a ListStreamingDistributions operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.ListStreamingDistributionsResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListStreamingDistributionsResult.WithStreamingDistributionList(Amazon.CloudFront.Model.StreamingDistributionList)"> <summary> Sets the StreamingDistributionList property </summary> <param name="streamingDistributionList">The value to set for the StreamingDistributionList property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ListStreamingDistributionsResult.StreamingDistributionList"> <summary> Gets and sets the property StreamingDistributionList. The StreamingDistributionList type. </summary> </member> <member name="T:Amazon.CloudFront.Model.LoggingConfig"> <summary> A complex type that controls whether access logs are written for the distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.LoggingConfig.WithBucket(System.String)"> <summary> Sets the Bucket property </summary> <param name="bucket">The value to set for the Bucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.LoggingConfig.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.LoggingConfig.WithIncludeCookies(System.Boolean)"> <summary> Sets the IncludeCookies property </summary> <param name="includeCookies">The value to set for the IncludeCookies property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.LoggingConfig.WithPrefix(System.String)"> <summary> Sets the Prefix property </summary> <param name="prefix">The value to set for the Prefix property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.LoggingConfig.Bucket"> <summary> Gets and sets the property Bucket. The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. </summary> </member> <member name="P:Amazon.CloudFront.Model.LoggingConfig.Enabled"> <summary> Gets and sets the property Enabled. Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted. </summary> </member> <member name="P:Amazon.CloudFront.Model.LoggingConfig.IncludeCookies"> <summary> Gets and sets the property IncludeCookies. Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies. </summary> </member> <member name="P:Amazon.CloudFront.Model.LoggingConfig.Prefix"> <summary> Gets and sets the property Prefix. An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element. </summary> </member> <member name="T:Amazon.CloudFront.Model.MissingBodyException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.MissingBodyException.#ctor(System.String)"> <summary> Constructs a new MissingBodyException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException.#ctor(System.String)"> <summary> Constructs a new NoSuchCloudFrontOriginAccessIdentityException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.NoSuchDistributionException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.NoSuchDistributionException.#ctor(System.String)"> <summary> Constructs a new NoSuchDistributionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.NoSuchInvalidationException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.NoSuchInvalidationException.#ctor(System.String)"> <summary> Constructs a new NoSuchInvalidationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.NoSuchOriginException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.NoSuchOriginException.#ctor(System.String)"> <summary> Constructs a new NoSuchOriginException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.NoSuchStreamingDistributionException.#ctor(System.String)"> <summary> Constructs a new NoSuchStreamingDistributionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.Origin"> <summary> A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin. </summary> </member> <member name="M:Amazon.CloudFront.Model.Origin.WithCustomOriginConfig(Amazon.CloudFront.Model.CustomOriginConfig)"> <summary> Sets the CustomOriginConfig property </summary> <param name="customOriginConfig">The value to set for the CustomOriginConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Origin.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Origin.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Origin.WithS3OriginConfig(Amazon.CloudFront.Model.S3OriginConfig)"> <summary> Sets the S3OriginConfig property </summary> <param name="s3OriginConfig">The value to set for the S3OriginConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Origin.CustomOriginConfig"> <summary> Gets and sets the property CustomOriginConfig. A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead. </summary> </member> <member name="P:Amazon.CloudFront.Model.Origin.DomainName"> <summary> Gets and sets the property DomainName. Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com. </summary> </member> <member name="P:Amazon.CloudFront.Model.Origin.Id"> <summary> Gets and sets the property Id. A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior. </summary> </member> <member name="P:Amazon.CloudFront.Model.Origin.S3OriginConfig"> <summary> Gets and sets the property S3OriginConfig. A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead. </summary> </member> <member name="T:Amazon.CloudFront.Model.Origins"> <summary> A complex type that contains information about origins for this distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.Origins.WithItems(Amazon.CloudFront.Model.Origin[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Origins.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.Origin})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Origins.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Origins.Items"> <summary> Gets and sets the property Items. A complex type that contains origins for this distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.Origins.Quantity"> <summary> Gets and sets the property Quantity. The number of origins for this distribution. </summary> </member> <member name="T:Amazon.CloudFront.Model.Paths"> <summary> A complex type that contains information about the objects that you want to invalidate. </summary> </member> <member name="M:Amazon.CloudFront.Model.Paths.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Paths.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Paths.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Paths.Items"> <summary> Gets and sets the property Items. A complex type that contains a list of the objects that you want to invalidate. </summary> </member> <member name="P:Amazon.CloudFront.Model.Paths.Quantity"> <summary> Gets and sets the property Quantity. The number of objects that you want to invalidate. </summary> </member> <member name="T:Amazon.CloudFront.Model.PreconditionFailedException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.PreconditionFailedException.#ctor(System.String)"> <summary> Constructs a new PreconditionFailedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.Restrictions"> <summary> A complex type that identifies ways in which you want to restrict distribution of your content. </summary> </member> <member name="M:Amazon.CloudFront.Model.Restrictions.WithGeoRestriction(Amazon.CloudFront.Model.GeoRestriction)"> <summary> Sets the GeoRestriction property </summary> <param name="geoRestriction">The value to set for the GeoRestriction property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Restrictions.GeoRestriction"> <summary> Gets and sets the property GeoRestriction. </summary> </member> <member name="T:Amazon.CloudFront.Model.S3Origin"> <summary> A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.S3Origin.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.S3Origin.WithOriginAccessIdentity(System.String)"> <summary> Sets the OriginAccessIdentity property </summary> <param name="originAccessIdentity">The value to set for the OriginAccessIdentity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.S3Origin.DomainName"> <summary> Gets and sets the property DomainName. The DNS name of the S3 origin. </summary> </member> <member name="P:Amazon.CloudFront.Model.S3Origin.OriginAccessIdentity"> <summary> Gets and sets the property OriginAccessIdentity. Your S3 origin's origin access identity. </summary> </member> <member name="T:Amazon.CloudFront.Model.S3OriginConfig"> <summary> A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead. </summary> </member> <member name="M:Amazon.CloudFront.Model.S3OriginConfig.WithOriginAccessIdentity(System.String)"> <summary> Sets the OriginAccessIdentity property </summary> <param name="originAccessIdentity">The value to set for the OriginAccessIdentity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.S3OriginConfig.OriginAccessIdentity"> <summary> Gets and sets the property OriginAccessIdentity. The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity. </summary> </member> <member name="T:Amazon.CloudFront.Model.Signer"> <summary> A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any. </summary> </member> <member name="M:Amazon.CloudFront.Model.Signer.WithAwsAccountNumber(System.String)"> <summary> Sets the AwsAccountNumber property </summary> <param name="awsAccountNumber">The value to set for the AwsAccountNumber property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.Signer.WithKeyPairIds(Amazon.CloudFront.Model.KeyPairIds)"> <summary> Sets the KeyPairIds property </summary> <param name="keyPairIds">The value to set for the KeyPairIds property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.Signer.AwsAccountNumber"> <summary> Gets and sets the property AwsAccountNumber. Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number. </summary> </member> <member name="P:Amazon.CloudFront.Model.Signer.KeyPairIds"> <summary> Gets and sets the property KeyPairIds. A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber. </summary> </member> <member name="T:Amazon.CloudFront.Model.StreamingDistribution"> <summary> A streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistribution.WithActiveTrustedSigners(Amazon.CloudFront.Model.ActiveTrustedSigners)"> <summary> Sets the ActiveTrustedSigners property </summary> <param name="activeTrustedSigners">The value to set for the ActiveTrustedSigners property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistribution.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistribution.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistribution.WithLastModifiedTime(System.DateTime)"> <summary> Sets the LastModifiedTime property </summary> <param name="lastModifiedTime">The value to set for the LastModifiedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistribution.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistribution.WithStreamingDistributionConfig(Amazon.CloudFront.Model.StreamingDistributionConfig)"> <summary> Sets the StreamingDistributionConfig property </summary> <param name="streamingDistributionConfig">The value to set for the StreamingDistributionConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistribution.ActiveTrustedSigners"> <summary> Gets and sets the property ActiveTrustedSigners. CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistribution.DomainName"> <summary> Gets and sets the property DomainName. The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistribution.Id"> <summary> Gets and sets the property Id. The identifier for the streaming distribution. For example: EGTXBD79H29TRA8. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistribution.LastModifiedTime"> <summary> Gets and sets the property LastModifiedTime. The date and time the distribution was last modified. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistribution.Status"> <summary> Gets and sets the property Status. The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistribution.StreamingDistributionConfig"> <summary> Gets and sets the property StreamingDistributionConfig. The current configuration information for the streaming distribution. </summary> </member> <member name="T:Amazon.CloudFront.Model.StreamingDistributionAlreadyExistsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new StreamingDistributionAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.StreamingDistributionConfig"> <summary> The configuration for the streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithAliases(Amazon.CloudFront.Model.Aliases)"> <summary> Sets the Aliases property </summary> <param name="aliases">The value to set for the Aliases property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithCallerReference(System.String)"> <summary> Sets the CallerReference property </summary> <param name="callerReference">The value to set for the CallerReference property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithComment(System.String)"> <summary> Sets the Comment property </summary> <param name="comment">The value to set for the Comment property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithLogging(Amazon.CloudFront.Model.StreamingLoggingConfig)"> <summary> Sets the Logging property </summary> <param name="logging">The value to set for the Logging property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithPriceClass(System.String)"> <summary> Sets the PriceClass property </summary> <param name="priceClass">The value to set for the PriceClass property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithS3Origin(Amazon.CloudFront.Model.S3Origin)"> <summary> Sets the S3Origin property </summary> <param name="s3Origin">The value to set for the S3Origin property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionConfig.WithTrustedSigners(Amazon.CloudFront.Model.TrustedSigners)"> <summary> Sets the TrustedSigners property </summary> <param name="trustedSigners">The value to set for the TrustedSigners property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.Aliases"> <summary> Gets and sets the property Aliases. A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.CallerReference"> <summary> Gets and sets the property CallerReference. A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.Comment"> <summary> Gets and sets the property Comment. Any comments you want to include about the streaming distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.Enabled"> <summary> Gets and sets the property Enabled. Whether the streaming distribution is enabled to accept end user requests for content. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.Logging"> <summary> Gets and sets the property Logging. A complex type that controls whether access logs are written for the streaming distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.PriceClass"> <summary> Gets and sets the property PriceClass. A complex type that contains information about price class for this streaming distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.S3Origin"> <summary> Gets and sets the property S3Origin. A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionConfig.TrustedSigners"> <summary> Gets and sets the property TrustedSigners. A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. </summary> </member> <member name="T:Amazon.CloudFront.Model.StreamingDistributionList"> <summary> A streaming distribution list. </summary> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionList.WithIsTruncated(System.Boolean)"> <summary> Sets the IsTruncated property </summary> <param name="isTruncated">The value to set for the IsTruncated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionList.WithItems(Amazon.CloudFront.Model.StreamingDistributionSummary[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionList.WithItems(System.Collections.Generic.IEnumerable{Amazon.CloudFront.Model.StreamingDistributionSummary})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionList.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionList.WithMaxItems(System.Int32)"> <summary> Sets the MaxItems property </summary> <param name="maxItems">The value to set for the MaxItems property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionList.WithNextMarker(System.String)"> <summary> Sets the NextMarker property </summary> <param name="nextMarker">The value to set for the NextMarker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionList.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionList.IsTruncated"> <summary> Gets and sets the property IsTruncated. A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionList.Items"> <summary> Gets and sets the property Items. A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionList.Marker"> <summary> Gets and sets the property Marker. The value you provided for the Marker request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionList.MaxItems"> <summary> Gets and sets the property MaxItems. The value you provided for the MaxItems request parameter. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionList.NextMarker"> <summary> Gets and sets the property NextMarker. If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionList.Quantity"> <summary> Gets and sets the property Quantity. The number of streaming distributions that were created by the current AWS account. </summary> </member> <member name="T:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException.#ctor(System.String)"> <summary> Constructs a new StreamingDistributionNotDisabledException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.StreamingDistributionSummary"> <summary> A summary of the information for an Amazon CloudFront streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithAliases(Amazon.CloudFront.Model.Aliases)"> <summary> Sets the Aliases property </summary> <param name="aliases">The value to set for the Aliases property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithComment(System.String)"> <summary> Sets the Comment property </summary> <param name="comment">The value to set for the Comment property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithLastModifiedTime(System.DateTime)"> <summary> Sets the LastModifiedTime property </summary> <param name="lastModifiedTime">The value to set for the LastModifiedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithPriceClass(System.String)"> <summary> Sets the PriceClass property </summary> <param name="priceClass">The value to set for the PriceClass property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithS3Origin(Amazon.CloudFront.Model.S3Origin)"> <summary> Sets the S3Origin property </summary> <param name="s3Origin">The value to set for the S3Origin property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingDistributionSummary.WithTrustedSigners(Amazon.CloudFront.Model.TrustedSigners)"> <summary> Sets the TrustedSigners property </summary> <param name="trustedSigners">The value to set for the TrustedSigners property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.Aliases"> <summary> Gets and sets the property Aliases. A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.Comment"> <summary> Gets and sets the property Comment. The comment originally specified when this distribution was created. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.DomainName"> <summary> Gets and sets the property DomainName. The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.Enabled"> <summary> Gets and sets the property Enabled. Whether the distribution is enabled to accept end user requests for content. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.Id"> <summary> Gets and sets the property Id. The identifier for the distribution. For example: EDFDVBD632BHDS5. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.LastModifiedTime"> <summary> Gets and sets the property LastModifiedTime. The date and time the distribution was last modified. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.PriceClass"> <summary> Gets and sets the property PriceClass. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.S3Origin"> <summary> Gets and sets the property S3Origin. A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.Status"> <summary> Gets and sets the property Status. Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingDistributionSummary.TrustedSigners"> <summary> Gets and sets the property TrustedSigners. A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. </summary> </member> <member name="T:Amazon.CloudFront.Model.StreamingLoggingConfig"> <summary> A complex type that controls whether access logs are written for this streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.StreamingLoggingConfig.WithBucket(System.String)"> <summary> Sets the Bucket property </summary> <param name="bucket">The value to set for the Bucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingLoggingConfig.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.StreamingLoggingConfig.WithPrefix(System.String)"> <summary> Sets the Prefix property </summary> <param name="prefix">The value to set for the Prefix property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.StreamingLoggingConfig.Bucket"> <summary> Gets and sets the property Bucket. The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingLoggingConfig.Enabled"> <summary> Gets and sets the property Enabled. Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted. </summary> </member> <member name="P:Amazon.CloudFront.Model.StreamingLoggingConfig.Prefix"> <summary> Gets and sets the property Prefix. An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element. </summary> </member> <member name="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyCacheBehaviorsException.#ctor(System.String)"> <summary> Constructs a new TooManyCacheBehaviorsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyCertificatesException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyCertificatesException.#ctor(System.String)"> <summary> Constructs a new TooManyCertificatesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyCloudFrontOriginAccessIdentitiesException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyCloudFrontOriginAccessIdentitiesException.#ctor(System.String)"> <summary> Constructs a new TooManyCloudFrontOriginAccessIdentitiesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException.#ctor(System.String)"> <summary> Constructs a new TooManyCookieNamesInWhiteListException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException.#ctor(System.String)"> <summary> Constructs a new TooManyDistributionCNAMEsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyDistributionsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyDistributionsException.#ctor(System.String)"> <summary> Constructs a new TooManyDistributionsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException.#ctor(System.String)"> <summary> Constructs a new TooManyHeadersInForwardedValuesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyInvalidationsInProgressException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyInvalidationsInProgressException.#ctor(System.String)"> <summary> Constructs a new TooManyInvalidationsInProgressException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyOriginsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyOriginsException.#ctor(System.String)"> <summary> Constructs a new TooManyOriginsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException.#ctor(System.String)"> <summary> Constructs a new TooManyStreamingDistributionCNAMEsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyStreamingDistributionsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyStreamingDistributionsException.#ctor(System.String)"> <summary> Constructs a new TooManyStreamingDistributionsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TooManyTrustedSignersException.#ctor(System.String)"> <summary> Constructs a new TooManyTrustedSignersException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new TrustedSignerDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudFront.Model.TrustedSigners"> <summary> A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.TrustedSigners.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.TrustedSigners.WithItems(System.String[])"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.TrustedSigners.WithItems(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Items property </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.TrustedSigners.WithQuantity(System.Int32)"> <summary> Sets the Quantity property </summary> <param name="quantity">The value to set for the Quantity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.TrustedSigners.Enabled"> <summary> Gets and sets the property Enabled. Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId. </summary> </member> <member name="P:Amazon.CloudFront.Model.TrustedSigners.Items"> <summary> Gets and sets the property Items. Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items. </summary> </member> <member name="P:Amazon.CloudFront.Model.TrustedSigners.Quantity"> <summary> Gets and sets the property Quantity. The number of trusted signers for this cache behavior. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest"> <summary> Container for the parameters to the UpdateCloudFrontOriginAccessIdentity operation. Update an origin access identity. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest.WithCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Sets the CloudFrontOriginAccessIdentityConfig property </summary> <param name="cloudFrontOriginAccessIdentityConfig">The value to set for the CloudFrontOriginAccessIdentityConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest.WithIfMatch(System.String)"> <summary> Sets the IfMatch property </summary> <param name="ifMatch">The value to set for the IfMatch property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest.CloudFrontOriginAccessIdentityConfig"> <summary> Gets and sets the property CloudFrontOriginAccessIdentityConfig. The identity's configuration information. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest.Id"> <summary> Gets and sets the property Id. The identity's id. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest.IfMatch"> <summary> Gets and sets the property IfMatch. The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResponse"> <summary> Returns information about the UpdateCloudFrontOriginAccessIdentityResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResponse.UpdateCloudFrontOriginAccessIdentityResult"> <summary> Gets and sets the UpdateCloudFrontOriginAccessIdentityResult property. Represents the output of a UpdateCloudFrontOriginAccessIdentity operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResult.WithCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity)"> <summary> Sets the CloudFrontOriginAccessIdentity property </summary> <param name="cloudFrontOriginAccessIdentity">The value to set for the CloudFrontOriginAccessIdentity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResult.CloudFrontOriginAccessIdentity"> <summary> Gets and sets the property CloudFrontOriginAccessIdentity. The origin access identity's information. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResult.ETag"> <summary> Gets and sets the property ETag. The current version of the configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateDistributionRequest"> <summary> Container for the parameters to the UpdateDistribution operation. Update a distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateDistributionRequest.WithDistributionConfig(Amazon.CloudFront.Model.DistributionConfig)"> <summary> Sets the DistributionConfig property </summary> <param name="distributionConfig">The value to set for the DistributionConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateDistributionRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateDistributionRequest.WithIfMatch(System.String)"> <summary> Sets the IfMatch property </summary> <param name="ifMatch">The value to set for the IfMatch property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.UpdateDistributionRequest.DistributionConfig"> <summary> Gets and sets the property DistributionConfig. The distribution's configuration information. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateDistributionRequest.Id"> <summary> Gets and sets the property Id. The distribution's id. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateDistributionRequest.IfMatch"> <summary> Gets and sets the property IfMatch. The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateDistributionResponse"> <summary> Returns information about the UpdateDistributionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateDistributionResponse.UpdateDistributionResult"> <summary> Gets and sets the UpdateDistributionResult property. Represents the output of a UpdateDistribution operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateDistributionResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateDistributionResult.WithDistribution(Amazon.CloudFront.Model.Distribution)"> <summary> Sets the Distribution property </summary> <param name="distribution">The value to set for the Distribution property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateDistributionResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.UpdateDistributionResult.Distribution"> <summary> Gets and sets the property Distribution. The distribution's information. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateDistributionResult.ETag"> <summary> Gets and sets the property ETag. The current version of the configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest"> <summary> Container for the parameters to the UpdateStreamingDistribution operation. Update a streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.WithIfMatch(System.String)"> <summary> Sets the IfMatch property </summary> <param name="ifMatch">The value to set for the IfMatch property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.WithStreamingDistributionConfig(Amazon.CloudFront.Model.StreamingDistributionConfig)"> <summary> Sets the StreamingDistributionConfig property </summary> <param name="streamingDistributionConfig">The value to set for the StreamingDistributionConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.Id"> <summary> Gets and sets the property Id. The streaming distribution's id. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.IfMatch"> <summary> Gets and sets the property IfMatch. The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.StreamingDistributionConfig"> <summary> Gets and sets the property StreamingDistributionConfig. The streaming distribution's configuration information. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateStreamingDistributionResponse"> <summary> Returns information about the UpdateStreamingDistributionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateStreamingDistributionResponse.UpdateStreamingDistributionResult"> <summary> Gets and sets the UpdateStreamingDistributionResult property. Represents the output of a UpdateStreamingDistribution operation. </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateStreamingDistributionResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateStreamingDistributionResult.WithETag(System.String)"> <summary> Sets the ETag property </summary> <param name="eTag">The value to set for the ETag property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.UpdateStreamingDistributionResult.WithStreamingDistribution(Amazon.CloudFront.Model.StreamingDistribution)"> <summary> Sets the StreamingDistribution property </summary> <param name="streamingDistribution">The value to set for the StreamingDistribution property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.UpdateStreamingDistributionResult.ETag"> <summary> Gets and sets the property ETag. The current version of the configuration. For example: E2QWRUHAPOMQZL. </summary> </member> <member name="P:Amazon.CloudFront.Model.UpdateStreamingDistributionResult.StreamingDistribution"> <summary> Gets and sets the property StreamingDistribution. The streaming distribution's information. </summary> </member> <member name="T:Amazon.CloudFront.Model.ViewerCertificate"> <summary> A complex type that contains information about viewer certificates for this distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.ViewerCertificate.WithCloudFrontDefaultCertificate(System.Boolean)"> <summary> Sets the CloudFrontDefaultCertificate property </summary> <param name="cloudFrontDefaultCertificate">The value to set for the CloudFrontDefaultCertificate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ViewerCertificate.WithIAMCertificateId(System.String)"> <summary> Sets the IAMCertificateId property </summary> <param name="iAMCertificateId">The value to set for the IAMCertificateId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront.Model.ViewerCertificate.WithSSLSupportMethod(System.String)"> <summary> Sets the SSLSupportMethod property </summary> <param name="sSLSupportMethod">The value to set for the SSLSupportMethod property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront.Model.ViewerCertificate.CloudFrontDefaultCertificate"> <summary> Gets and sets the property CloudFrontDefaultCertificate. If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId. </summary> </member> <member name="P:Amazon.CloudFront.Model.ViewerCertificate.IAMCertificateId"> <summary> Gets and sets the property IAMCertificateId. If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate. </summary> </member> <member name="P:Amazon.CloudFront.Model.ViewerCertificate.SSLSupportMethod"> <summary> Gets and sets the property SSLSupportMethod. If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate. </summary> </member> <member name="T:Amazon.CloudFront.Util.AmazonCloudFrontUtil"> <summary> Provides utilities used by the Amazon CloudFront client implementation. </summary> </member> <member name="M:Amazon.CloudFront.Util.AmazonCloudFrontUtil.CreateHeaderEntry(System.String,System.String)"> <summary> Builds and returns the name value collection that can be added to the HTTP headers for the request </summary> <param name="key">The key to be added to the headers (eg. Content-Body)</param> <param name="value">The value of the key being added</param> <returns>A NameValueCollection with just one key-value pair</returns> </member> <member name="M:Amazon.CloudFront.Util.AmazonCloudFrontUtil.Sign(System.String,System.Security.SecureString,System.Security.Cryptography.KeyedHashAlgorithm)"> <summary> Computes RFC 2104-compliant HMAC signature </summary> <param name="data">The data to be signed</param> <param name="key">The secret signing key</param> <param name="algorithm">The algorithm to sign the data with</param> <returns>A string representing the HMAC signature</returns> </member> <member name="M:Amazon.CloudFront.Util.AmazonCloudFrontUtil.UrlEncode(System.String,System.Boolean)"> <summary> URL encodes a string. If the path property is specified, the accepted characters {/:+} are not encoded. </summary> <param name="data">The string to encode</param> <param name="path">Whether the string is a URL path or not</param> <returns></returns> </member> <member name="P:Amazon.CloudFront.Util.AmazonCloudFrontUtil.FormattedCurrentTimestamp"> <summary> Formats the current date as a GMT timestamp </summary> <returns>A GMT formatted string representation of the current date and time </returns> </member> <member name="T:Amazon.CloudFront_2012_03_15.AmazonCloudFront"> <summary> Interface for Amazon CloudFront Clients. For more information about Amazon CloudFront, <see href="http://aws.amazon.com/cloudfront"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.ListDistributions"> <summary> List Distributions </summary> <returns>List Distributions Response from the service</returns> <remarks> The ListDistributions operation lists all of the distributions associated with your account. </remarks> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.ListDistributions(Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest)"> <summary> List Distributions </summary> <param name="request">The ListDistributionsRequest with values for the Marker and MaxItems properties set</param> <returns>List Distributions Response from the service</returns> <remarks> The ListDistributions operation lists all of the distributions associated with your account. </remarks> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetDistributionConfig(Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigRequest)"> <summary> The GetDistributionConfig gets the Configuration for the CloudFront distribution. For more information on the format of the CloudFront Distribution Configuration object, please refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html"/> </summary> <param name="request">The GetDistributionConfigRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetDistributionInfo(Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoRequest)"> <summary> The GetDistributionInfo operation gets the complete information asociated with a distribution. For more information on what information is returned by CloudFront, please refer: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/AboutCreatingDistributions.html"/><br /> and <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIRe/DistributionDatatype.html"/> </summary> <param name="request"> The GetDistributionInfoRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetDistributionInfoResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.SetDistributionConfig(Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest)"> <summary> The SetDistributionConfig operation sets the configuration for a CloudFront distribution. The returned response contains only the headers from CloudFront. </summary> <param name="request"> The SetDistributionConfigRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a SetDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.CreateDistribution(Amazon.CloudFront_2012_03_15.Model.CreateDistributionRequest)"> <summary> The CreateDistribution operation creates a new CloudFront Distribution. </summary> <param name="request"> The CreateDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a CreateDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.DeleteDistribution(Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest)"> <summary> The DeleteDistribution operation deletes the distribution specified in the request. </summary> <param name="request"> The DeleteDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a DeleteDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.CreateOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityRequest)"> <summary> The CreateOriginAccessIdentity operation creates a new CloudFront Access Identity. You can create up to 100 per AWS account. <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html" /> </summary> <param name="request"> The CreateOriginAccessIdentityRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a CreateOriginAccessIdentityResponse from CloudFront.</returns> <seealso cref="T:Amazon.CloudFront.Model.CreateOriginAccessIdentityRequest"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.DeleteOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest)"> <summary> The DeleteOriginAccessIdentity operation deletes the origin access identity specified in the request. </summary> <param name="request"> The DeleteOriginAccessIdentityRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a DeleteOriginAccessIdentityResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.ListOriginAccessIdentities"> <summary> The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities owned by the authenticated sender of the request. </summary> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.ListOriginAccessIdentities(Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest)"> <summary> The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities owned by the authenticated sender of the request. </summary> <param name="request">The ListOriginAccessIdentitiesRequest with values for the Marker and MaxItems properties set</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetOriginAccessIdentityInfo(Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoRequest)"> <summary> The GetOriginAccessIdentityInfo operation gets the complete information asociated with an Origin Access Identity. For more information on what information is returned by CloudFront, please refer: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/GetOAI.html"/><br /> - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/OAIDatatype.html"/> </summary> <param name="request"> The GetOriginAccessIdentityInfoRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetOriginAccessIdentityInfoResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigRequest)"> <summary> The GetOriginAccessIdentityConfig gets the Configuration for the CloudFront Origin Access Identity. For more information on the format of the CloudFront Origin Access Identity Configuration object, please refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/OAIConfigDatatype.html"/> </summary> <param name="request">The GetOriginAccessIdentityConfigRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetOriginAccessIdentityConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.SetOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest)"> <summary> The SetOriginAccessIdentityConfig operation sets the configuration for a CloudFront Origin Access Identity. The returned response contains only the headers from CloudFront. </summary> <param name="request"> The SetOriginAccessIdentityConfigRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a SetOriginAccessIdentityConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.ListStreamingDistributions"> <summary> List CloudFront Streaming Distributions </summary> <returns>List Streaming Distributions Response from the service</returns> <remarks> The ListStreamingDistributions operation lists all of the streaming distributions associated with your account. </remarks> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.ListStreamingDistributions(Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest)"> <summary> List CloudFront Streaming Distributions </summary> <param name="request">The ListStreamingDistributionsRequest with values for the Marker and MaxItems properties set</param> <returns>List Streaming Distributions Response from the service</returns> <remarks> The ListStreamingDistributions operation lists all of the distributions associated with your account. </remarks> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigRequest)"> <summary> The GetStreamingDistributionConfig gets the Configuration for the streaming distribution. For more information on the format of the CloudFront StreamingDistribution Configuration object, please refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionConfigDatatype.html"/> </summary> <param name="request">The GetStreamingDistributionConfigRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetStreamingDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetStreamingDistributionInfo(Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoRequest)"> <summary> The GetStreamingDistributionInfo operation gets the complete information asociated with a streaming distribution. For more information on what information is returned by CloudFront, please refer: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/AboutCreatingStreamingDistributions.html"/><br /> - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionDatatype.html"/> </summary> <param name="request"> The GetStreamingDistributionInfoRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetStreamingDistributionInfoResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.SetStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest)"> <summary> The SetStreamingDistributionConfig operation sets the configuration for a CloudFront streaming distribution. The returned response contains only the headers from CloudFront. </summary> <param name="request"> The SetStreamingDistributionConfigRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a SetStreamingDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.CreateStreamingDistribution(Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionRequest)"> <summary> The CreateStreamingDistribution operation creates a new CloudFront StreamingDistribution. </summary> <param name="request"> The CreateStreamingDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a CreateStreamingDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.DeleteStreamingDistribution(Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest)"> <summary> The DeleteStreamingDistribution operation deletes the streaming distribution specified in the request. </summary> <param name="request"> The DeleteStreamingDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a DeleteStreamingDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.PostInvalidation(Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest)"> <summary> The PostInvalidation operation invalidates objects specified in the PostInvalidationRequest which will cause Cloudfront to go back to the origin to get a new copy. <code> PostInvalidationRequest request = new PostInvalidationRequest(); request.DistributionId = distributionId; request.InvalidationBatch.CallerReference = callerReference; request.InvalidationBatch.WithPaths("/image1.jpg", "/image2.jpg"); PostInvalidationResponse response = cfcClient.PostInvalidation(request); </code> </summary> <param name="request">The PostInvalidationRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a PostInvalidationResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetInvalidationList(Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest)"> <summary> The GetInvalidationList operation will return back a list of all the invalidations done for a distribution for the current and previous billing period. If the list is long, you can paginate it using the MaxItems and Marker parameters <code> GetInvalidationListRequest request = new GetInvalidationListRequest(); request.DistributionId = distributionId; GetInvalidationListResponse response = cfcClient.GetInvalidationList(request); </code> </summary> <param name="request">The GetInvalidationListRequest that defines the parameters of the operation. Distribution id is a required parameter.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetInvalidationListResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFront.GetInvalidation(Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest)"> <summary> The GetInvalidation operation returns back the details for a specific invalidation. <code> GetInvalidationRequest request = new GetInvalidationRequest() .WithDistribtionId(distributionId) .WithInvalidationId(invalidationId); GetInvalidationResponse response = cfcClient.GetInvalidation(request); </code> </summary> <param name="request">The GetInvalidationRequest that defines the parameters of the operation. Distribution id and Invalidation id are required parameters.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetInvalidationResponse from CloudFront.</returns> </member> <member name="T:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient"> <summary> AmazonCloudFrontClient is an implementation of AmazonCloudFront; the client allows you to manage your CloudFront distributions and origin access identities.<br /> If you want to use the AmazonCloudFrontClient from a Medium Trust hosting environment, please create the client with an AmazonCloudFrontConfig object whose UseSecureStringForAwsSecretKey property is false. </summary> <remarks> Amazon CloudFront provides a simple web services interface that can be used to store and retrieve any amount of data, at any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable, fast, inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites. The service aims to maximize benefits of scale and to pass those benefits on to developers. </remarks> <seealso cref="P:Amazon.CloudFront.AmazonCloudFrontConfig.UseSecureStringForAwsSecretKey"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.Dispose(System.Boolean)"> <summary> Implements the Dispose pattern for the AmazonCloudFrontClient </summary> <param name="fDisposing">Whether this object is being disposed via a call to Dispose or garbage collected.</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.Finalize"> <summary> The destructor for the client class. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.#ctor(Amazon.CloudFront_2012_03_15.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonEC2 Configuration Object</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.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_2012_03_15.AmazonCloudFrontClient.#ctor(System.String,System.String,Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFront Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="config">The CloudFront Configuration Object</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.#ctor(System.String,System.Security.SecureString,Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig)"> <summary> Constructs an AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an Amazon CloudFront Configuration object </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key as a SecureString</param> <param name="config">The CloudFront Configuration Object</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs an AmazonCloudFrontClient with AWSCredentials </summary> <param name="credentials"></param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig)"> <summary> Constructs an AmazonCloudFrontClient with AWSCredentials and an AmazonCloudFront Configuration object </summary> <param name="credentials"></param> <param name="config"></param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.PostInvalidation(Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest)"> <summary> The PostInvalidation operation invalidates objects specified in the PostInvalidationRequest which will cause Cloudfront to go back to the origin to get a new copy. <code> PostInvalidationRequest request = new PostInvalidationRequest(); request.DistributionId = distributionId; request.InvalidationBatch.CallerReference = callerReference; request.InvalidationBatch.WithPaths("/image1.jpg", "/image2.jpg"); PostInvalidationResponse response = cfcClient.PostInvalidation(request); </code> </summary> <param name="request">The PostInvalidationRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a PostInvalidationResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetInvalidationList(Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest)"> <summary> The GetInvalidationList operation will return back a list of all the invalidations done for a distribution for the current and previous billing period. If the list is long, you can paginate it using the MaxItems and Marker parameters <code> GetInvalidationListRequest request = new GetInvalidationListRequest(); request.DistributionId = distributionId; GetInvalidationListResponse response = cfcClient.GetInvalidationList(request); </code> </summary> <param name="request">The GetInvalidationListRequest that defines the parameters of the operation. Distribution id is a required parameter.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetInvalidationListResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetInvalidation(Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest)"> <summary> The GetInvalidation operation returns back the details for a specific invalidation. <code> GetInvalidationRequest request = new GetInvalidationRequest() .WithDistribtionId(distributionId) .WithInvalidationId(invalidationId); GetInvalidationResponse response = cfcClient.GetInvalidation(request); </code> </summary> <param name="request">The GetInvalidationRequest that defines the parameters of the operation. Distribution id and Invalidation id are required parameters.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetInvalidationResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ListDistributions"> <summary> The ListDistributions operation returns a list of all of the distributions owned by the authenticated sender of the request. </summary> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a ListDistributionsResponse with the response from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ListDistributions(Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest)"> <summary> The ListDistributions operation returns a list of all of the distributions owned by the authenticated sender of the request. </summary> <param name="request">The ListDistributionsRequest with values for the Marker and MaxItems properties set</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a ListDistributionsResponse with the response from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetDistributionConfig(Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigRequest)"> <summary> The GetDistributionConfig gets the Configuration for the CloudFront distribution. For more information on the format of the CloudFront Distribution Configuration object, please refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html"/> </summary> <param name="request">The GetDistributionConfigRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetDistributionInfo(Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoRequest)"> <summary> The GetDistributionInfo operation gets the complete information asociated with a distribution. For more information on what information is returned by CloudFront, please refer: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/AboutCreatingDistributions.html"/><br /> - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionDatatype.html"/> </summary> <param name="request"> The GetDistributionInfoRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetDistributionInfoResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.SetDistributionConfig(Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest)"> <summary> The SetDistributionConfig operation sets the configuration for a CloudFront distribution. </summary> <param name="request"> The SetDistributionConfigRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a SetDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.CreateDistribution(Amazon.CloudFront_2012_03_15.Model.CreateDistributionRequest)"> <summary> The CreateDistribution operation creates a new CloudFront Distribution. </summary> <seealso href="http://docs.amazonwebservices.com/AmazonCloudFront/2010-11-01/APIReference/CreateDistribution.html"> POST Distribution API Reference</seealso> <param name="request"> The CreateDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a CreateDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.DeleteDistribution(Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest)"> <summary> The DeleteDistribution operation deletes the distribution specified in the request. </summary> <seealso href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html"> Deleting a Distribution Developer Guide</seealso> <param name="request"> The DeleteDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a DeleteDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.CreateOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityRequest)"> <summary> The CreateOriginAccessIdentity operation creates a new CloudFront Access Identity. You can create up to 100 per AWS account. <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html" /> </summary> <param name="request"> The CreateOriginAccessIdentityRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a CreateOriginAccessIdentityResponse from CloudFront.</returns> <seealso cref="T:Amazon.CloudFront.Model.CreateOriginAccessIdentityRequest"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.DeleteOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest)"> <summary> The DeleteOriginAccessIdentity operation deletes the origin access identity specified in the request. </summary> <param name="request"> The DeleteOriginAccessIdentityRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a DeleteOriginAccessIdentityResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ListOriginAccessIdentities"> <summary> The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities owned by the authenticated sender of the request. </summary> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ListOriginAccessIdentities(Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest)"> <summary> The ListOriginAccessIdentities operation returns a list of all of the Origin Access Identities owned by the authenticated sender of the request. </summary> <param name="request">The ListOriginAccessIdentitiesRequest with values for the Marker and MaxItems properties set</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a ListOriginAccessIdentitiesResponse with the response from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetOriginAccessIdentityInfo(Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoRequest)"> <summary> The GetOriginAccessIdentityInfo operation gets the complete information asociated with an Origin Access Identity. For more information on what information is returned by CloudFront, please refer: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/GetOAI.html"/><br /> - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/OAIDatatype.html"/> </summary> <param name="request"> The GetOriginAccessIdentityInfoRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetOriginAccessIdentityInfoResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigRequest)"> <summary> The GetOriginAccessIdentityConfig gets the Configuration for the CloudFront Origin Access Identity. For more information on the format of the CloudFront Origin Access Identity Configuration object, please refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/OAIConfigDatatype.html"/> </summary> <param name="request">The GetOriginAccessIdentityConfigRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetOriginAccessIdentityConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.SetOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest)"> <summary> The SetOriginAccessIdentityConfig operation sets the configuration for a CloudFront Origin Access Identity. </summary> <param name="request"> The SetOriginAccessIdentityConfigRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a SetOriginAccessIdentityConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ListStreamingDistributions"> <summary> List CloudFront Streaming Distributions </summary> <returns>List Streaming Distributions Response from the service</returns> <remarks> The ListStreamingDistributions operation lists all of the streaming distributions associated with your account. </remarks> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ListStreamingDistributions(Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest)"> <summary> List CloudFront Streaming Distributions </summary> <param name="request">The ListStreamingDistributionsRequest with values for the Marker and MaxItems properties set</param> <returns>List Streaming Distributions Response from the service</returns> <remarks> The ListStreamingDistributions operation lists all of the distributions associated with your account. </remarks> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigRequest)"> <summary> The GetStreamingDistributionConfig gets the Configuration for the streaming distribution. For more information on the format of the CloudFront StreamingDistribution Configuration object, please refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionConfigDatatype.html"/> </summary> <param name="request">The GetStreamingDistributionConfigRequest that defines the parameters of the operation.</param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetStreamingDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetStreamingDistributionInfo(Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoRequest)"> <summary> The GetStreamingDistributionInfo operation gets the complete information asociated with a streaming distribution. For more information on what information is returned by CloudFront, please refer: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/AboutCreatingStreamingDistributions.html"/><br /> - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionDatatype.html"/> </summary> <param name="request"> The GetStreamingDistributionInfoRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a GetStreamingDistributionInfoResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.SetStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest)"> <summary> The SetStreamingDistributionConfig operation sets the configuration for a CloudFront distribution. </summary> <param name="request"> The SetStreamingDistributionConfigRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a SetStreamingDistributionConfigResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.CreateStreamingDistribution(Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionRequest)"> <summary> The CreateStreamingDistribution operation creates a new CloudFront StreamingDistribution. </summary> <seealso href="http://docs.amazonwebservices.com/AmazonCloudFront/2010-11-01/APIReference/CreateStreamingDistribution.html"> POST Streaming Distribution API Reference</seealso> <param name="request"> The CreateStreamingDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a CreateStreamingDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.DeleteStreamingDistribution(Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest)"> <summary> The DeleteStreamingDistribution operation deletes the distribution specified in the request. </summary> <param name="request"> The DeleteStreamingDistributionRequest that defines the parameters of the operation. </param> <exception cref="T:System.ArgumentNullException"></exception> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.CloudFront.AmazonCloudFrontException"></exception> <returns>Returns a DeleteStreamingDistributionResponse from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertListDistributions(Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest)"> Convert ListDistributionsRequest to key/value pairs </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertGetDistributionInfo(Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoRequest)"> Convert GetDistributionInfoRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertGetDistributionConfig(Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigRequest)"> Convert GetDistributionConfigRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertSetDistributionConfig(Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest)"> Convert SetDistributionInfoRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertCreateDistribution(Amazon.CloudFront_2012_03_15.Model.CreateDistributionRequest)"> Convert CreateDistributionRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertDeleteDistribution(Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest)"> Convert DeleteDistributionRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertCreateOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityRequest)"> Convert CreateOriginAccessIdentityRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertDeleteOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest)"> Convert DeleteOriginAccessIdentityRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertListOriginAccessIdentities(Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest)"> Convert ListOriginAccessIdentitiessRequest to key/value pairs </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertGetOriginAccessIdentityInfo(Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoRequest)"> Convert GetOriginAccessIdentityInfoRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertGetOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigRequest)"> Convert GetOriginAccessIdentityConfigRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertSetOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest)"> Convert SetOriginAccessIdentityInfoRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertListStreamingDistributions(Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest)"> Convert ListStreamingDistributionsRequest to key/value pairs </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertCreateStreamingDistribution(Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionRequest)"> Convert CreateStreamingDistributionRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertGetStreamingDistributionInfo(Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoRequest)"> Convert GetStreamingDistributionInfoRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertGetStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigRequest)"> Convert GetStreamingDistributionConfigRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertSetStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest)"> Convert SetStreamingDistributionInfoRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConvertDeleteStreamingDistribution(Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest)"> Convert DeleteStreamingDistributionRequest to key/value pairs. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.AddCloudFrontQueryParameters(System.Collections.Generic.IDictionary{Amazon.CloudFront_2012_03_15.Model.CloudFrontQueryParameter,System.String},System.Net.WebHeaderCollection)"> Add authentication related and version parameters </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.Invoke``1(System.Collections.Generic.IDictionary{Amazon.CloudFront_2012_03_15.Model.CloudFrontQueryParameter,System.String},System.Net.WebHeaderCollection)"> Invoke request and return response </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.GetServiceSpecificDataFromHeader(Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse)"> Sets the headers we want to expose to the user from the response. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.ConfigureWebRequest(System.Collections.Generic.IDictionary{Amazon.CloudFront_2012_03_15.Model.CloudFrontQueryParameter,System.String},System.Net.WebHeaderCollection,System.Int64,Amazon.Runtime.ImmutableCredentials)"> Configure HttpClient with set of defaults as well as configuration from AmazonEC2Config instance </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.PauseOnRetry(System.Int32,System.Int32,System.Net.HttpStatusCode,System.String,System.Net.WebHeaderCollection,System.Exception)"> Exponential sleep on failed request </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.BuildSigningString(System.Net.WebHeaderCollection,System.Security.SecureString)"> Creates a string based on the parameters and encrypts it using key. Returns the encrypted string. </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontClient.BuildSigningString(System.Net.WebHeaderCollection,System.String)"> Creates a string based on the parameters and encrypts it using key. Returns the encrypted string. </member> <member name="T:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig"> <summary> Configuration for Amazon CloudFront Client. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithServiceURL(System.String)"> <summary> Sets the ServiceURL property </summary> <param name="serviceURL">ServiceURL property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetServiceURL"> <summary> Checks if ServiceURL property is set </summary> <returns>true if ServiceURL property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithUserAgent(System.String)"> <summary> Sets the UserAgent property </summary> <param name="userAgent">UserAgent property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetUserAgent"> <summary> Checks if UserAgent property is set </summary> <returns>true if UserAgent property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithProxyHost(System.String)"> <summary> Sets the ProxyHost property </summary> <param name="proxyHost">ProxyHost property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetProxyHost"> <summary> Checks if ProxyHost property is set </summary> <returns>true if ProxyHost property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithProxyPort(System.Int32)"> <summary> Sets the ProxyPort property </summary> <param name="proxyPort">ProxyPort property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetProxyPort"> <summary> Checks if ProxyPort property is set </summary> <returns>true if ProxyPort property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithProxyCredentials(System.Net.ICredentials)"> <summary> Sets the ProxyCredentials property. </summary> <param name="proxyCredentials">ProxyCredentials property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetProxyCredentials"> <summary> Checks if ProxyCredentials property is set </summary> <returns>true if ProxyCredentials property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithMaxErrorRetry(System.Int32)"> <summary> Sets the MaxErrorRetry property </summary> <param name="maxErrorRetry">MaxErrorRetry property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetMaxErrorRetry"> <summary> Checks if MaxErrorRetry property is set </summary> <returns>true if MaxErrorRetry property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithUseSecureStringForAwsSecretKey(System.Boolean)"> <summary> Sets the UseSecureString property. By default, the AWS Secret Access Key is stored in a SecureString (true) - this is one of the secure ways to store a secret provided by the .NET Framework. But, the use of SecureStrings is not supported in Medium Trust Windows Hosting environments. If you are building an ASP.NET application that needs to run with Medium Trust, set this property to false, and the client will not save your AWS Secret Key in a secure string. Changing the default to false can result in the Secret Key being vulnerable; please use this property judiciously. </summary> <param name="fSecure"> Whether a secure string should be used or not. </param> <returns>The Config object with the property set</returns> <remarks>Storing the AWS Secret Access Key is not recommended unless absolutely necessary. </remarks> <seealso cref="T:System.Security.SecureString"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithProxyUsername(System.String)"> <summary> Sets the ProxyUsername property </summary> <param name="userName">Value for the ProxyUsername property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetProxyUsername"> <summary> Checks if ProxyUsername property is set </summary> <returns>true if ProxyUsername property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.WithProxyPassword(System.String)"> <summary> Sets the ProxyPassword property. Used in conjunction with the ProxyUsername property to authenticate requests with the specified Proxy server. </summary> <remarks> If this property isn't set, String.Empty is used as the proxy password. This property isn't used if ProxyUsername is null or empty. </remarks> <param name="password">ProxyPassword property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.IsSetProxyPassword"> <summary> Checks if ProxyPassword property is set </summary> <returns>true if ProxyPassword property is set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.ServiceURL"> <summary> Gets and sets of the ServiceURL property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.UserAgent"> <summary> Gets and sets of the UserAgent property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.ProxyHost"> <summary> Gets and sets of the ProxyHost property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.ProxyPort"> <summary> Gets and sets of the ProxyPort property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.ProxyCredentials"> <summary> Credentials to use with a proxy. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.MaxErrorRetry"> <summary> Gets and sets of the MaxErrorRetry property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.UseSecureStringForAwsSecretKey"> <summary> Gets and Sets the UseSecureString property. By default, the AWS Secret Access Key is stored in a SecureString (true) - this is one of the secure ways to store a secret provided by the .NET Framework. But, the use of SecureStrings is not supported in Medium Trust Windows Hosting environments. If you are building an ASP.NET application that needs to run with Medium Trust, set this property to false, and the client will not save your AWS Secret Key in a secure string. Changing the default to false can result in the Secret Key being vulnerable; please use this property judiciously. </summary> <remarks>Storing the AWS Secret Access Key is not recommended unless absolutely necessary. </remarks> <seealso cref="T:System.Security.SecureString"/> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.ProxyUsername"> <summary> Gets and sets the ProxyUsername property. Used in conjunction with the ProxyPassword property to authenticate requests with the specified Proxy server. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.ProxyPassword"> <summary> Gets and sets the ProxyPassword property. Used in conjunction with the ProxyUsername property to authenticate requests with the specified Proxy server. </summary> <remarks> If this property isn't set, String.Empty is used as the proxy password. This property isn't used if ProxyUsername is null or empty. </remarks> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontConfig.ConnectionLimit"> <summary> Gets and sets the connection limit set on the ServicePoint for the WebRequest. Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in which case ServicePointManager.DefaultConnectionLimit will be used as the default. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException"> <summary> Amazon CloudFront Exception provides details of errors returned by Amazon CloudFront service </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.#ctor"> <summary> Initializes a new AmazonCloudFrontException with default values. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.#ctor(System.String)"> <summary> Initializes a new AmazonCloudFrontException with a specified error message </summary> <param name="message">A message that describes the error</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.#ctor(System.Exception)"> <summary> Initializes a new AmazonCloudFrontException from the inner exception that is the cause of this exception. </summary> <param name="innerException">The nested exception that caused the AmazonCloudFrontException</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new AmazonCloudFrontException with serialized data. </summary> <param name="info">The object that holds the serialized object data. </param> <param name="context">The contextual information about the source or destination. </param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializes this instance of AmazonCloudFrontException. </summary> <param name="info">The object that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination. </param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.#ctor(System.String,System.Exception)"> <summary> Initializes a new AmazonCloudFrontException with a specific error message and the inner exception that is the cause of this exception. </summary> <param name="message">Overview of error</param> <param name="innerException">The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.#ctor(System.String,System.Net.HttpStatusCode)"> <summary> Initializes an AmazonCloudFrontException with a specific message and HTTP status code </summary> <param name="message">Overview of error</param> <param name="statusCode">HTTP status code for error response</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.#ctor(System.String,System.Net.HttpStatusCode,System.String,System.String,System.String,System.String,System.String,System.Net.WebHeaderCollection,System.Exception)"> <summary> Initializes an AmazonCloudFrontException with error information provided in an AmazonCloudFront response. </summary> <param name="message">Overview of error</param> <param name="statusCode">HTTP status code for error response</param> <param name="errorCode">Error Code returned by the service</param> <param name="requestId">Request ID returned by the service</param> <param name="type">Error Type</param> <param name="xml">Compete xml found in response</param> <param name="requestAddr">The CloudFront request url</param> <param name="responseHeaders">The response headers containing CloudFront specific information</param> <param name="innerException">The exception that is the cause of the current exception. If the innerException parameter is not a null reference, the current exception is raised in a catch block that handles the inner exception.</param> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.HostId"> <summary> Gets the HostId property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.ErrorCode"> <summary> Gets the ErrorCode property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.Message"> <summary> Gets error message </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.StatusCode"> <summary> Gets status code returned by the service if available. If status code is set to -1, it means that status code was unavailable at the time exception was thrown </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.XML"> <summary> Gets XML returned by the service if available. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.RequestId"> <summary> Gets Request ID returned by the service if available. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.CloudFrontRequestAddress"> <summary> Gets the CloudFront service address used to make this request. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.AmazonCloudFrontException.ResponseHeaders"> <summary> Gets the error response HTTP headers so that CloudFront specific information can be retrieved for debugging. Interesting fields are: a. x-amz-id-2 b. x-amz-request-id c. Date A value can be retrieved from this HeaderCollection via: ResponseHeaders.Get("key"); </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.BaseRequest"> <summary> Base class for Cloudfront operations that provides headers. </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.BaseRequest.headers"> <summary> The protected member that holds the service specific headers with which the HTTP Request is configured. This is used by all derived Requests </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.BaseRequest.IsSetHeaders"> <summary> Checks if Headers property is set </summary> <returns>true if Headers property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.BaseRequest.AddHeaders(System.Collections.Specialized.NameValueCollection)"> <summary> Adds all of the key/value pairs from collection into our request header. </summary> <param name="collection">A collection of key/value headers</param> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.BaseRequest.Headers"> <summary> Gets the Headers property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistribution"> <summary> Describes a CloudFront Distribution. It is used as a response element when Creating a Distribution and Getting a Distribution's Information. <para>A distribution consists of the following items: <list type="number"> <item>Id</item> <item>Status</item> <item>Last Modified Timestamp</item> <item>Domain Name</item> <item>The Configuration for the Distribution</item> </list> </para> For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionDatatype.html"/> </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase"> <summary> The DistributionBase contains the common elements of a CloudFront distribution. <para>The shared elements are: <list type="number"> <item>Id</item> <item>Status</item> <item>Last Modified Timestamp</item> <item>Domain Name</item> <item>The Configuration for the Distribution</item> </list> </para> For more information, please visit: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionDatatype.html"/><br /> - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionDatatype.html"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.IsSetId"> <summary> Checks if Id property is set. </summary> <returns>true if Id property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.IsSetStatus"> <summary> Checks if Status property is set. </summary> <returns>true if Status property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.IsSetLastModifiedTime"> <summary> Checks if LastModifiedTime property is set. </summary> <returns>true if LastModifiedTime property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.IsSetDomainName"> <summary> Checks if DomainName property is set </summary> <returns>true if DomainName property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.IsSetETag"> <summary> Checks if the ETag property is set. </summary> <returns>true if ETag property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.IsSetActiveTrustedSigners"> <summary> Checks if ActiveTrustedSigners property is set. </summary> <returns>true if ActiveTrustedSigners property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.ToString"> <summary> Returns the string representation of the distribution. </summary> <returns> A string representing the distribution </returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.Id"> <summary> Gets and sets the Id property. This is the Id returned by CloudFront when the distribution is created and is unique to the Distribution. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.Status"> <summary> Gets and sets the Status property. The current status of the Distribution can either be Deployed or In Progres </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.LastModifiedTime"> <summary> Gets and sets the LastModifiedTime property. The date and time the distribution was last modified. The string returned is the GMT representation of DateTime. The date is in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (e.g., 2008-07-24T19:37:58Z) </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.DomainName"> <summary> Gets and sets the DomainName property. The domain name corresponding to the distribution. For example, e604721fxaaqy9.cloudfront.net. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.ETag"> <summary> Gets and sets the ETag property of this Distribution's information. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionBase.ActiveTrustedSigners"> <summary> Gets and sets the ActiveTrustedSigners property. This specifies any AWS accounts you want to permit to create signed URLs for private content. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistribution.IsSetConfig"> <summary> Checks if DistributionConfig property is set </summary> <returns>true if DistributionConfig property is set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistribution.DistributionConfig"> <summary> Gets and sets the current Distribution Configuration. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig"> <summary> The CloudFrontDistributionConfig complex type describes a distribution's configuration information. It is used as a request element in Create a Distribution and Set a Distribution's Configuration. It is used as a response element in Get a Distribution's Information and Get a Distribution's Configuration. <para>A distribution configuration objects consists of the following items: <list type="number"> <item>Caller Reference</item> <item>Origin S3 Bucket</item> <item>Comment</item> <item>A list of CNAMEs for the distribution</item> <item>Enabled flag</item> <item>Bucket Logging details</item> <item>CloudFront Origin Access Identity associated with the distribution. This is a virtual identity you use to let CloudFront fetch private content from your bucket.</item> <item>The AWS Accounts that have URL signing privileges for Private Content.</item> </list> </para> For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html"/> </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase"> <summary> Describes the elements shared by the various distribution configurations. <para>The elements shared between configuration objects are: <list type="number"> <item>Caller Reference</item> <item>Origin S3 Bucket</item> <item>Comment</item> <item>A list of CNAMEs for the distribution</item> <item>Enabled flag</item> <item>Bucket Logging details</item> <item>CloudFront Origin Access Identity associated with the distribution. This is a virtual identity you use to let CloudFront fetch private content from your bucket.</item> <item>The AWS Accounts that have URL signing privileges for Private Content.</item> </list> </para> For more information, please visit: - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html"/><br /> - <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionConfigDatatype.html"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.ToString"> <summary> Returns the string representation of this object. </summary> <returns> A string representing the configuration. </returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.IsSetComment"> <summary> Checks if Comment property is set. </summary> <returns>true if Comment property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.IsSetCallerReference"> <summary> Checks if CallerReference property is set </summary> <returns>true if CallerReference property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.IsSetCNames"> <summary> Checks if CNAME property is set </summary> <returns>true if CNAME property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.IsSetETag"> <summary> Checks if ETag property is set. </summary> <returns>true if ETag property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.IsSetTrustedSigners"> <summary> Checks if TrustedSigners property is set. </summary> <returns>true if TrustedSigners property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.IsSetLogging"> <summary> Checks if the Logging property is set. </summary> <returns>true if the Logging property is set.</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.S3Origin"> <summary> Gets and sets the S3Origin property. The S3Origin contains the Amazon S3 bucket that will be used for the Distribution. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.Origin"> <summary> Gets and sets the Origin property. The Amazon S3 bucket to associate with the distribution. For example: mybucket.s3.amazonaws.com. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.Comment"> <summary> Gets and sets the Comment property. Any comments you want to include about the distribution. The maximum length of the comment is 128 characters </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.CallerReference"> <summary> Gets and sets the CallerReference property. A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontDistributionConfig object), a new distribution is created. </summary> <remarks> <para>If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the CloudFrontDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.</para> <para>If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the CloudFrontDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.</para> </remarks> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.CNAME"> <summary> Gets and Sets the CNAME property. A CNAME alias you want to associate with this distribution. You can have up to 10 CNAME aliases per distribution. For more information, refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html"/> </summary> <remarks> Only include a CNAME element if you have a CNAME to associate with the distribution. Don't include an empty CNAME element in the CloudFrontDistributionConfig object. If you do, CloudFront returns a MalformedXML error. Only 10 CNAME aliases can be specified for a distribution. </remarks> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.Enabled"> <summary> Gets and sets the Enabled property. Whether the distribution is enabled to accept end user requests for content. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.ETag"> <summary> Gets and sets the ETag property of the Distribution Config. The ETag is the current version of the Distribution's Configuration. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.OriginAccessIdentity"> <summary> Gets and sets the OriginAccessIdentity property. The CloudFront origin access identity to associate with the distribution. If you want the distribution to serve private content, include this element; if you want the distribution to serve public content, remove this element. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.TrustedSigners"> <summary> Gets and sets the TrustedSigners property. This specifies any AWS accounts you want to permit to create signed URLs for private content. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfigBase.Logging"> <summary> Gets and Sets the Logging property. A complex type that controls whether access logs are written for the distribution. For more information, refer: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html"/> </summary> <remarks> The Bucket specifies where the CloudFront access logs will be stored. Maximum length is 128 characters and it must conform to Amazon S3 V2 bucket criteria. <para>The Prefix is an optional string of your choice to prefix to the access log filenames for this distribution. Maximum length is 256 characters and it can't start with a '/'</para> </remarks> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.ToString"> <summary> Creates an XML representation of the CloudFront distribution configuration. The resulting XML can be sent to CloudFront when creating or updating a distribution. </summary> <returns> XML representation of the distribution's configuration </returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithOrigin(System.String)"> <summary> Sets the Origin property. </summary> <param name="origin">Origin property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithComment(System.String)"> <summary> Sets the Comment property. </summary> <param name="comment">Comment property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithCallerReference(System.String)"> <summary> Sets the CallerReference property </summary> <param name="callerReference">CallerReference property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithCNames(System.String[])"> <summary> Sets the CNAME property. If you set more than 10 CNAME aliases for a distribution, a <code>TooManyDistributionCNAMEs</code> exception will be returned by CloudFront. </summary> <param name="cnames">CNAME property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">Enabled property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity)"> <summary> Sets the OriginAccessIdentity property. </summary> <param name="identity">OriginAccessIdentity property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithTrustedSigners(Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners)"> <summary> Sets the TrustedSigners property. This specifies any AWS accounts you want to permit to create signed URLs for private content. </summary> <param name="signers">TrustedSigners property is set to this value</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithCustomOrigin(Amazon.CloudFront_2012_03_15.Model.CustomOrigin)"> <summary> Sets the CustomOrigin property. The CustomOrigin contains the information for a non Amazon S3 Bucket origin. This instance is returned to allow method chaining. </summary> <param name="customOrigin">CustomOrigin property is set to this value.</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithLogging(System.String,System.String)"> <summary> Sets the Logging property. </summary> <param name="bucket">The bucket into which logs will be put</param> <param name="prefix">The prefix for the log files</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.IsSetRequiredProtocols"> <summary> Checks if RequiredProtocols property is set. </summary> <returns>true if RequiredProtocols property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithRequiredProtocols(Amazon.CloudFront_2012_03_15.Model.Protocol[])"> <summary> Sets the RequiredProtocols property. Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request. For a list of possible protocol values, refer <see cref="T:Amazon.CloudFront.Model.Protocol"/>. </summary> <param name="protocols">RequiredProtocols property is set to this value</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.WithDefaultRootObject(System.String)"> <summary> Sets the DefaultRootObject property. </summary> <param name="rootObject">The name of the default root object.</param> <returns>This instance.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.IsDefaultRootObjectSet"> <summary> Checks to see if the DefaultRootObject property is set. </summary> <returns>True if DefaultRootObject is set. False otherwise.</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.CustomOrigin"> <summary> Gets and sets the CustomOrigin property. The CustomOrigin contains the information for a non Amazon S3 Bucket origin. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.RequiredProtocols"> <summary> Gets and sets the RequiredProtocols property. Defines the protocols required for your distribution. Use this element to restrict access to your distribution solely to HTTPS requests. Without this element, CloudFront can use any available protocol to serve the request. For a list of possible protocol values, refer <see cref="T:Amazon.CloudFront.Model.Protocol"/>. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig.DefaultRootObject"> <summary> Gets and sets the DefaultRootObject property. Defines the object that will be returned for requests made to the root URL of the distribution. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.Protocol"> <summary> The protocols allowed as a RequiredProtocol by a CloudFront Distribution's configuration. </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.Protocol.https"> <summary> The HTTPS protocol </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontError"> <summary> Represents an error returned by the CloudFront service. Exposes an error code, a message, a host ID and a request ID for debugging purposes. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontError.WithCode(System.String)"> <summary> Sets the Code property. </summary> <param name="code">Code property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontError.IsSetCode"> <summary> Checks if Code property is set. </summary> <returns>true if Code property is set.</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontError.Code"> <summary> Gets and sets the Code property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontError.Message"> <summary> Gets and sets the Message property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontError.Type"> <summary> Gets and sets the Type property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontError.RequestId"> <summary> Gets and sets the RequestId property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity"> <summary> A CloudFrontOriginAccessIdentity describes the information about a CloudFront Origin Access Identity. It is used as a response element when Creating a new CloudFront Origin Access Identity and when an Origin Access Identity's details are retrieved. <para>An origin access identity consists of the following items: <list type="number"> <item>Id</item> <item>S3 Canonical User Id</item> <item>The Configuration for the Origin Access Identity</item> </list> </para> For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/OAIConfigDatatype.html"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.IsSetId"> <summary> Checks if Id property is set. </summary> <returns>true if Id property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.IsSetS3CanonicalUserId"> <summary> Checks if S3CanonicalUserId property is set. </summary> <returns>true if S3CanonicalUserId property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.IsSetConfig"> <summary> Checks if OriginAccessIdentityConfig property is set </summary> <returns>true if OriginAccessIdentityConfig property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.ToString"> <summary> Creates an XML representation of this CloudFront Origin Access Identity. </summary> <returns> XML representation of the Origin Access Identity </returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.IsSetETag"> <summary> Checks if the ETag property is set. </summary> <returns>true if ETag property is set.</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.Id"> <summary> Gets and sets the Id property. This is the Id returned by CloudFront when the distribution is created and is unique to the Distribution. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.S3CanonicalUserId"> <summary> Gets and sets the Status property. The current status of the Distribution can either be Deployed or In Progres </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.OriginAccessIdentityConfig"> <summary> Gets and sets the current Origin Access Identity Configuration. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity.ETag"> <summary> Gets and sets the ETag property of this Origin Access Identity's Information. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig"> <summary> The CloudFrontOriginAccessIdentityConfig complex type describes an origin access identity's configuration information. <para>An origin access identity configuration objects consists of the following items: <list type="number"> <item>Caller Reference</item> <item>Comment</item> </list> </para> For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.ToString"> <summary> Creates an XML representation of the CloudFront distribution configuration. The resulting XML can be sent to CloudFront when creating or updating a distribution. </summary> <returns> XML representation of the distribution's configuration </returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.WithComment(System.String)"> <summary> Sets the Comment property. </summary> <param name="comment">Comment property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.IsSetComment"> <summary> Checks if Comment property is set. </summary> <returns>true if Comment property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.WithCallerReference(System.String)"> <summary> Sets the CallerReference property </summary> <param name="callerReference">CallerReference property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.IsSetCallerReference"> <summary> Checks if CallerReference property is set </summary> <returns>true if CallerReference property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.IsSetETag"> <summary> Checks if the ETag property is set. </summary> <returns>true if ETag property is set.</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.Comment"> <summary> Gets and sets the Comment property. Any comments you want to include about the distribution. The maximum length of the comment is 128 characters </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.CallerReference"> <summary> Gets and sets the CallerReference property. A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new distribution is created. The default value set by the AWS SDK for NET is the UtcNow timestamp. </summary> <remarks> <para>If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.</para> <para>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.</para> </remarks> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig.ETag"> <summary> Gets and sets the ETag property of this Origin Access Identity Configuration. The ETag is the current version of the configuration. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest"> <summary> Base class for CloudFront operation requests. Provides a header collection which can is used to store the request headers. </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.distId"> <summary> The ID of the CloudFront distribution <list type="number"> <item>Get Distribution Config</item> <item>Get Distribution Info</item> <item>Set Distribution Config</item> <item>Delete Distribution</item> </list> </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.etagHeader"> <summary> The ETag for the distribution. </summary> <remarks> This value is returned by the CloudFront service when: <list type="number"> <item>a distribution is created</item> <item>a distribution's info is requested</item> <item>a distribution's config is requested</item> <item>a distribution's config is modified</item> </list> </remarks> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.dConfig"> <summary> The CloudFront Distribution Config object used by: <list type="number"> <item>Set Distribution Config</item> <item>Create Distribution</item> </list> </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.sdConfig"> <summary> The CloudFront Streaming Distribution Config object used by: <list type="number"> <item>Set Streaming Distribution Config</item> <item>Create Streaming Distribution</item> </list> </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.reqMarker"> <summary> All keys returned will be lexiographically after the marker. Used by ListDistributionsRequest </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.reqMaxItems"> <summary> Limits the result set of keys to MaxItems. Used by ListDistributionsRequest </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.IsSetId"> <summary> Checks if Id property is set. </summary> <returns>true if Id property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.IsSetETag"> <summary> Checks if ETag property is set. </summary> <returns>true if ETag property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.IsSetDistributionConfig"> <summary> Checks if DistributionConfig property is set. </summary> <returns>true if DistributionConfig property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.IsSetStreamingDistributionConfig"> <summary> Checks if StreamingDistributionConfig property is set. </summary> <returns>true if StreamingDistributionConfig property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.IsSetMarker"> <summary> Checks if Marker property is set </summary> <returns>true if Marker property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.IsSetMaxItems"> <summary> Checks if MaxItems property is set </summary> <returns>true if MaxItems property is set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.Id"> <summary> Gets and sets the Id property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.ETag"> <summary> Gets and sets the ETag property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.DistributionConfig"> <summary> Gets and Sets the DistributionConfig property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.StreamingDistributionConfig"> <summary> Gets and Sets the StreamingDistributionConfig property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.Marker"> <summary> Gets and sets the Marker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontRequest.MaxItems"> <summary> Gets and sets the MaxItems property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse"> <summary> Base class for all CloudFront operation responses. Provides a header collection which is used to store the response headers. Also exposes the RequestId and AmazonId2 from CloudFront responses. </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse.etagHeader"> <summary> The ETag Header returned by CloudFront that uniquely identifies the configuration or information returned </summary> </member> <member name="F:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse.webHeaders"> <summary> web headers for all requests. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse.ToString"> <summary> Returns the string representation of the response. </summary> <returns> A string representing the response. </returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse.RequestId"> <summary> Gets and sets the RequestId property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse.Headers"> <summary> Gets and sets the Headers property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse.XML"> <summary> Gets and sets the XML property. This is the original XML response received from CloudFront </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontResponse.ETag"> <summary> Gets and sets the ETag property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistribution"> <summary> Describes a CloudFront Streaming Distribution. It is used as a response element when Creating a Distribution and Getting a Distribution's Information. <para>A distribution consists of the following items: <list type="number"> <item>Id</item> <item>Status</item> <item>Last Modified Timestamp</item> <item>Domain Name</item> <item>The Configuration for the Distribution</item> </list></para> For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionDatatype.html"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistribution.IsSetConfig"> <summary> Checks if StreamingDistributionConfig property is set </summary> <returns>true if StreamingDistributionConfig property is set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistribution.StreamingDistributionConfig"> <summary> Gets and sets the Streaming Distribution's Configuration. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig"> <summary> Describes a streaming distribution's configuration. It is used as a request element in Create a Distribution and Set a Distribution's Configuration. It is used as a response element in Get a Distribution's Information and Get a Distribution's Configuration. <para>A streaming distribution configuration objects consists of the following items: <list type="number"> <item>Caller Reference</item> <item>Origin S3 Bucket</item> <item>Comment</item> <item>A list of CNAMEs for the distribution</item> <item>Enabled flag</item> <item>Bucket Logging details</item> <item>CloudFront Origin Access Identity associated with the distribution. This is a virtual identity you use to let CloudFront fetch private content from your bucket.</item> <item>The AWS Accounts that have URL signing privileges for Private Content.</item> </list></para> For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/StreamingDistributionConfigDatatype.html"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.ToString"> <summary> Creates an XML representation of the CloudFront distribution configuration. The resulting XML can be sent to CloudFront when creating or updating a distribution. </summary> <returns> XML representation of the distribution's configuration </returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithOrigin(System.String)"> <summary> Sets the Origin property. </summary> <param name="origin">Origin property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithComment(System.String)"> <summary> Sets the Comment property. </summary> <param name="comment">Comment property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithCallerReference(System.String)"> <summary> Sets the CallerReference property </summary> <param name="callerReference">CallerReference property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithCNames(System.String[])"> <summary> Sets the CNAME property. If you set more than 10 CNAME aliases for a distribution, a <code>TooManyDistributionCNAMEs</code> exception will be returned by CloudFront. </summary> <param name="cnames">CNAME property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">Enabled property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity)"> <summary> Sets the OriginAccessIdentity property. </summary> <param name="identity">OriginAccessIdentity property</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithTrustedSigners(Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners)"> <summary> Sets the TrustedSigners property. This specifies any AWS accounts you want to permit to create signed URLs for private content. </summary> <param name="signers">TrustedSigners property is set to this value</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig.WithLogging(System.String,System.String)"> <summary> Sets the Logging property. </summary> <param name="bucket">The bucket into which logs will be put</param> <param name="prefix">The prefix for the log files</param> <returns>this instance</returns> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CreateDistributionRequest"> <summary> The CreateDistributionRequest contains the parameters used for the CreateDistribution operation. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CreateDistributionRequest.WithDistributionConfig(Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig)"> <summary> Sets the DistributionConfig property for this request. </summary> <param name="distributionConfig">The value that DistributionConfig is set to</param> <returns>the request with the Id set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateDistributionRequest.DistributionConfig"> <summary> Gets and Sets the DistributionConfig property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CreateDistributionResponse"> <summary> The CreateDistributionResponse contains any headers and the Distribution Config for the distribution created. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateDistributionResponse.Distribution"> <summary> Gets and sets the Distribution property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateDistributionResponse.ETag"> <summary> Gets and sets the ETag property. The Distribution's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityRequest"> <summary> The CreateOriginAccessIdentityRequest contains the parameters used for the CreateOriginAccessIdentity operation. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityRequest.WithOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Sets the OriginAccessIdentityConfig property for this request. </summary> <param name="oaiConfig">The value that OriginAccessIdentityConfig is set to</param> <returns>the request with the Id set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityRequest.OriginAccessIdentityConfig"> <summary> Gets and Sets the OriginAccessIdentityConfig property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityResponse"> <summary> This response contains any headers and the CloudFrontOriginAccessIdentity Config for the CloudFront Origin Access Identity created. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityResponse.OriginAccessIdentity"> <summary> Gets and sets the OriginAccessIdentity property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityResponse.Location"> <summary> Gets and sets the Location property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateOriginAccessIdentityResponse.ETag"> <summary> Gets and sets the ETag property. The Origin Access Identity's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionRequest"> <summary> The CreateStreamingDistributionRequest contains the parameters used for the CreateStreamingDistribution operation. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionRequest.WithStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig)"> <summary> Sets the StreamingDistributionConfig property for this request. </summary> <param name="distributionConfig">The value that StreamingDistributionConfig is set to</param> <returns>the request with the Id set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionRequest.StreamingDistributionConfig"> <summary> Gets and Sets the StreamingDistributionConfig property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionResponse"> <summary> The CreateStreamingDistributionResponse contains any headers and the StreamingDistribution Config for the distribution created. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionResponse.StreamingDistribution"> <summary> Gets and sets the StreamingDistribution property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CreateStreamingDistributionResponse.ETag"> <summary> Gets and sets the ETag property. The Streaming Distribution's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.OriginProtocolPolicy"> <summary> The origin protocol policy to apply to your origin. If HttpOnly is specified, CloudFront will use HTTP only to access the origin. If MatchViewer is specified, CloudFront will fetch from your origin using HTTP or HTTPS, based on the protocol of the viewer request. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.CustomOrigin"> <summary> Custom origin information to associate with the distribution. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.#ctor"> <summary> Initializes a new instance of the CustomOrigin class. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.#ctor(System.String)"> <summary> Initializes a new instance of the CustomOrigin class. </summary> <param name="dnsName">The DNS name of your Amazon S3 bucket.</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.WithDNSName(System.String)"> <summary> Sets the origin to associate with the distribution. For example: www.example.com. This instance is returned to allow method chaining. </summary> <param name="dnsName">The DNSName for the origin.</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.WithHttpPort(System.Int32)"> <summary> Sets the HTTP port. This instance is returned to allow method chaining. </summary> <param name="httpPort">The HTTP port.</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.WithHttpsPort(System.Int32)"> <summary> Sets the HTTPS port. This instance is returned to allow method chaining. </summary> <param name="httpsPort">The HTTPS port.</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.WithProtocolPolicy(Amazon.CloudFront_2012_03_15.Model.OriginProtocolPolicy)"> <summary> Sets the origin protocol policy to apply to your origin. If HttpOnly is specified, CloudFront will use HTTP only to access the origin. If MatchViewer is specified, CloudFront will fetch from your origin using HTTP or HTTPS, based on the protocol of the viewer request. This instance is returned to allow method chaining. </summary> <param name="protocolPolicy">The origin protocol policy.</param> <returns>This instance</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.DNSName"> <summary> Gets or sets the origin to associate with the distribution. For example: www.example.com. </summary> <value>The DNSName for the origin.</value> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.HttpPort"> <summary> Gets or sets the HTTP port. </summary> <value>The HTTP port.</value> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.HttpsPort"> <summary> Gets or sets the HTTPS port. </summary> <value>The HTTPS port.</value> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.CustomOrigin.ProtocolPolicy"> <summary> Gets or sets the origin protocol policy to apply to your origin. If HttpOnly is specified, CloudFront will use HTTP only to access the origin. If MatchViewer is specified, CloudFront will fetch from your origin using HTTP or HTTPS, based on the protocol of the viewer request. </summary> <value>The origin protocol policy.</value> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest"> <summary> The DeleteDistributionRequest contains the parameters used for the DeleteDistribution operation. <br />Required Parameters: Id <br />Required Parameters: ETag </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The distribution's id</param> <returns>The request with the Id property set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest.WithETag(System.String)"> <summary> Sets the ETag property of this request to the value passed in. </summary> <param name="etag">The distribution's etag</param> <returns>The request with the ETag property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest.Id"> <summary> Gets and sets the Id property for the Distribution </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.DeleteDistributionRequest.ETag"> <summary> Gets and sets the ETag property for the Distribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.DeleteDistributionResponse"> <summary> The DeleteDistributionResponse contains any headers returned by CloudFront. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest"> <summary> The DeleteOriginAccessIdentityRequest contains the parameters used for the DeleteOriginAccessIdentity operation. <br />Required Parameters: Id <br />Required Parameters: ETag </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The OriginAccessIdentity's id</param> <returns>The request with the Id property set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest.WithETag(System.String)"> <summary> Sets the ETag property of this request to the value passed in. </summary> <param name="etag">The OriginAccessIdentity's etag</param> <returns>The request with the ETag property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest.Id"> <summary> Gets and sets the Id property for the OriginAccessIdentity </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityRequest.ETag"> <summary> Gets and sets the ETag property for the OriginAccessIdentity </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.DeleteOriginAccessIdentityResponse"> <summary> The DeleteOriginAccessIdentityResponse contains any headers returned by CloudFront. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest"> <summary> The DeleteStreamingDistributionRequest contains the parameters used for the DeleteStreamingDistribution operation. <br />Required Parameters: Id <br />Required Parameters: ETag </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The StreamingDistribution's id</param> <returns>The request with the Id property set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest.WithETag(System.String)"> <summary> Sets the ETag property of this request to the value passed in. </summary> <param name="etag">The StreamingDistribution's etag</param> <returns>The request with the ETag property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest.Id"> <summary> Gets and sets the Id property for the StreamingDistribution </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionRequest.ETag"> <summary> Gets and sets the ETag property for the StreamingDistribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.DeleteStreamingDistributionResponse"> <summary> The DeleteStreamingDistributionResponse contains any headers returned by CloudFront. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.ErrorResponse"> <summary> This class contains all the errors returned by the CloudFront service. The errors are parsed from the Response XML provided by the HTTPWebResponse embedded in the WebException thrown during Response retrieval. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.ErrorResponse.ToXML"> <summary> XML Representation for this object </summary> <returns>XML String</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ErrorResponse.Error"> <summary> Gets and sets the Error property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ErrorResponse.RequestId"> <summary> Gets and sets the RequestId property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigRequest"> <summary> The GetDistributionConfigRequest contains the parameters used for the GetDistributionConfig operation. <br />Required Parameters: Id </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The distribution's id</param> <returns>The request with the Id property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigRequest.Id"> <summary> Gets and sets the Id property for the Distribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigResponse"> <summary> The GetDistributionConfigResponse contains the distribution's configuration and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigResponse.DistributionConfig"> <summary> Gets and Sets the DistributionConfig property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetDistributionConfigResponse.ETag"> <summary> Gets and sets the ETag property. The Distribution Configuration's ETag property is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoRequest"> <summary> The GetDistributionInfoRequest contains the parameters used for the GetDistributionInfo operation. <br />Required Parameter: Id </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The distribution's id</param> <returns>The request with the Id property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoRequest.Id"> <summary> Gets and sets the Id property for the Distribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoResponse"> <summary> The GetDistributionInfoResponse contains all the information about the GetDistributionInfo operation and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoResponse.Distribution"> <summary> Gets and sets the Distribution property. This contains all the information (including the configuration) for a cloudfront distribution. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetDistributionInfoResponse.ETag"> <summary> Gets and sets the ETag property. The Distribution's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest"> <summary> The GetInvalidationListRequest contains the parameters used for the GetInvalidationList operation. <br />Required Parameter: DistributionId </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest.WithMarker(System.String)"> <summary> Sets the Marker property for this request. All keys returned will be lexiographically after the marker. </summary> <param name="marker">the value that Marker is set to</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest.WithMaxItems(System.Int32)"> <summary> Sets the MaxItems property for this request. Limits the result set of keys to MaxItems. </summary> <param name="maxItems">the value that MaxItems is set to</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest.WithDistributionId(System.String)"> <summary> Sets the DistributionId property of this request to the value passed in. </summary> <param name="distributionId">The distribution's id</param> <returns>The request with the DistributionId property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest.Marker"> <summary> Gets and sets the Marker property. All keys returned will be lexiographically after the marker. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest.MaxItems"> <summary> Gets and sets the MaxItems property. Limits the result set of keys to MaxItems. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListRequest.DistributionId"> <summary> Gets and Sets the DistributionId property for the Distribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListResponse"> <summary> The GetInvalidationListResponse contains the list of invalidations done on a particular distribution and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListResponse.Marker"> <summary> Gets and Sets the Marker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListResponse.NextMarker"> <summary> Gets and Sets the NextMarker property. If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidations where they left off. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListResponse.MaxItems"> <summary> Gets and Sets the MaxItems property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListResponse.IsTruncated"> <summary> Gets and Sets the IsTruncated property which indicated whether all the data was returned from Cloudfront. If the value is true the NextMarker property can be used on another request to get the next page of data. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationListResponse.Summaries"> <summary> Gets and Sets the Summaries property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest"> <summary> The GetInvalidationRequest contains the parameters used for the GetInvalidation operation. <br />Required Parameter: DistributionId, InvalidationId </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest.WithInvalidationId(System.String)"> <summary> Sets the InvalidationId property of this request to the value passed in. </summary> <param name="invalidationId">The invalidation's id</param> <returns>The request with the InvalidationId property set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest.WithDistributionId(System.String)"> <summary> Sets the DistributionId property of this request to the value passed in. </summary> <param name="distributionId">The distribution's id</param> <returns>The request with the DistributionId property set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest.WithDistribtionId(System.String)"> <summary> Sets the DistributionId property of this request to the value passed in. </summary> <param name="distributionId">The distribution's id</param> <returns>The request with the DistributionId property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest.InvalidationId"> <summary> Gets and Sets the InvalidationId property for the invalidation </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationRequest.DistributionId"> <summary> Gets and Sets the DistributionId property for the Distribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetInvalidationResponse"> <summary> The GetInvalidationResponse contains the details of a particular invalidation and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationResponse.Status"> <summary> Gets and Sets the Status property. Valid Values are InProgress and Completed </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationResponse.Id"> <summary> Gets and Sets the Id property which is the invalidation id </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationResponse.CreateTime"> <summary> Gets and Sets the CreateTime property which is the date and time the invalidation request was first made. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetInvalidationResponse.InvalidationBatch"> <summary> Gets and Sets the InvalidationBatch property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigRequest"> <summary> The GetOriginAccessIdentityConfigRequest contains the parameters used for the GetOriginAccessIdentityConfig operation. <br />Required Parameters: Id </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The OriginAccessIdentity's id</param> <returns>The request with the Id property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigRequest.Id"> <summary> Gets and sets the Id property for the Origin Access Identity </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigResponse"> <summary> The GetOriginAccessIdentityConfigResponse contains the Origin Access Identity's configuration and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigResponse.OriginAccessIdentityConfig"> <summary> Gets and Sets the OriginAccessIdentityConfig property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityConfigResponse.ETag"> <summary> Gets and sets the ETag property. The Origin Access Identity's Configuration ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoRequest"> <summary> The GetOriginAccessIdentityInfoRequest contains the parameters used for the GetOriginAccessIdentityInfo operation. <br />Required Parameter: Id </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The OriginAccessIdentity's id</param> <returns>The request with the Id property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoRequest.Id"> <summary> Gets and sets the Id property for the Origin Access Identity </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoResponse"> <summary> The GetOriginAccessIdentityInfoResponse contains all the information about the GetOriginAccessIdentityInfo operation and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoResponse.OriginAccessIdentity"> <summary> Gets and sets the OriginAccessIdentity property. This contains all the information (including the configuration) for a CloudFront Origin Access Identity. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetOriginAccessIdentityInfoResponse.ETag"> <summary> Gets and sets the ETag property. The Origin Access Identity's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigRequest"> <summary> The GetStreamingDistributionConfigRequest contains the parameters used for the GetStreamingDistributionConfig operation. <br />Required Parameters: Id </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The StreamingDistribution's id</param> <returns>The request with the Id property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigRequest.Id"> <summary> Gets and sets the Id property for the StreamingDistribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigResponse"> <summary> The GetStreamingDistributionConfigResponse contains the StreamingDistribution's configuration and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigResponse.StreamingDistributionConfig"> <summary> Gets and Sets the StreamingDistributionConfig property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionConfigResponse.ETag"> <summary> Gets and sets the ETag property. The Streaming Distribution's Configuration ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoRequest"> <summary> The GetStreamingDistributionInfoRequest contains the parameters used for the GetStreamingDistributionInfo operation. <br />Required Parameter: Id </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoRequest.WithId(System.String)"> <summary> Sets the Id property of this request to the value passed in. </summary> <param name="id">The StreamingDistribution's id</param> <returns>The request with the Id property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoRequest.Id"> <summary> Gets and sets the Id property for the StreamingDistribution </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoResponse"> <summary> The GetStreamingDistributionInfoResponse contains all the information about the GetStreamingDistributionInfo operation and any headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoResponse.StreamingDistribution"> <summary> Gets and sets the StreamingDistribution property. This contains all the information (including the configuration) for a cloudfront StreamingDistribution. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.GetStreamingDistributionInfoResponse.ETag"> <summary> Gets and sets the ETag property. The Streaming Distribution's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch"> <summary> Contains a list of paths to objects that are to be invalidated and a CallerReference to ensure the request can't be replayed. For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/index.html?InvalidationBatchDatatype.html"/> </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.#ctor(System.String)"> <summary> Constructs and instance of InvalidationBatch with a callerReference. </summary> <param name="callerReference">A unique name that ensures the request can't be replayed.</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.#ctor(System.String,System.Collections.Generic.List{System.String})"> <summary> Constructs and instance of InvalidationBatch with a callerReference and a list of paths to objects. </summary> <param name="callerReference">A unique name that ensures the request can't be replayed.</param> <param name="paths">A list of paths to objects that will be invalidated.</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.WithCallerReference(System.String)"> <summary> Sets the CallerReference property and returns back this instance to chain method calls. </summary> <param name="callerReference">A unique name that ensures the request can't be replayed.</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.WithPaths(System.String[])"> <summary> Adds paths to the collection of path strings and returns back this instance to chain method calls. </summary> <param name="path">A list of paths to objects that will be invalidated</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.WithPaths(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds paths to the collection of path strings and returns back this instance to chain method calls. </summary> <param name="paths">A list of paths to objects that will be invalidated</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.ToString"> <summary> Creates a XML representation of this object and returns it back as a string. </summary> <returns>A XML string representing this object.</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.CallerReference"> <summary> Gets and Sets the CallerReference property a unique name that ensures the request can't be replayed. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.InvalidationBatch.Paths"> <summary> Gets and Sets the Paths property which is a list of paths to objects that will be invalidated. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.InvalidationSummary"> <summary> Contains a list of invalidation summaries. For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/InvalidationListDatatype.html"/> </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.InvalidationSummary.Id"> <summary> Gets and Sets the id of the invalidation. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.InvalidationSummary.Status"> <summary> Gets and Sets the status of the invalidation. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest"> <summary> The ListDistributionsRequest contains the parameters used for the ListDistributions operation. All parameters to this request object are optional. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest.WithMarker(System.String)"> <summary> Sets the Marker property for this request. All keys returned will be lexiographically after the marker. </summary> <param name="marker">the value that Marker is set to</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest.WithMaxItems(System.String)"> <summary> Sets the MaxItems property for this request. Limits the result set of keys to MaxItems. </summary> <param name="maxItems">the value that MaxItems is set to</param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest.Marker"> <summary> Gets and sets the Marker property. All keys returned will be lexiographically after the marker. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListDistributionsRequest.MaxItems"> <summary> Gets and sets the MaxItems property. Limits the result set of keys to MaxItems. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.ListDistributionsResponse"> <summary> The ListDistributionsResponse contains the ListDistributionsResult and any headers or metadata returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListDistributionsResponse.Distribution"> <summary> Gets the Distribution property as a List </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListDistributionsResponse.Marker"> <summary> Gets and sets the Marker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListDistributionsResponse.MaxItems"> <summary> Gets and sets the MaxItems property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListDistributionsResponse.NextMarker"> <summary> Gets and sets the NextMarker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListDistributionsResponse.IsTruncated"> <summary> Gets and sets the IsTruncated property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest"> <summary> The ListOriginAccessIdentitiesRequest contains the parameters used for the ListOriginAccessIdentities operation. All parameters to this request object are optional. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest.WithMarker(System.String)"> <summary> Sets the Marker property for this request. All keys returned will be lexiographically after the marker. </summary> <param name="marker">the value that Marker is set to</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest.WithMaxItems(System.String)"> <summary> Sets the MaxItems property for this request. Limits the result set of keys to MaxItems. </summary> <param name="maxItems">the value that MaxItems is set to</param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest.Marker"> <summary> Gets and sets the Marker property. All keys returned will be lexiographically after the marker. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesRequest.MaxItems"> <summary> Gets and sets the MaxItems property. Limits the result set of keys to MaxItems. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesResponse"> <summary> The ListOriginAccessIdentitiesResponse contains the ListOriginAccessIdentitiesResult and any headers or metadata returned by CloudFront. </summary> <seealso href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/ListOAIs.html"> Amazon CloudFront Get Origin Access Identity List</seealso> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesResponse.OriginAccessIdentities"> <summary> Gets the List of Origin Access Identities returned by CloudFront </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesResponse.Marker"> <summary> Gets and sets the Marker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesResponse.MaxItems"> <summary> Gets and sets the MaxItems property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesResponse.NextMarker"> <summary> Gets and sets the NextMarker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListOriginAccessIdentitiesResponse.IsTruncated"> <summary> Gets and sets the IsTruncated property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest"> <summary> The ListStreamingDistributionsRequest contains the parameters used for the ListStreamingDistributions operation. All parameters to this request object are optional. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest.WithMarker(System.String)"> <summary> Sets the Marker property for this request. All keys returned will be lexiographically after the marker. </summary> <param name="marker">the value that Marker is set to</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest.WithMaxItems(System.String)"> <summary> Sets the MaxItems property for this request. Limits the result set of keys to MaxItems. </summary> <param name="maxItems">the value that MaxItems is set to</param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest.Marker"> <summary> Gets and sets the Marker property. All keys returned will be lexiographically after the marker. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsRequest.MaxItems"> <summary> Gets and sets the MaxItems property. Limits the result set of keys to MaxItems. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsResponse"> <summary> The ListStreamingDistributionsResponse contains the ListStreamingDistributionsResult and any headers or metadata returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsResponse.StreamingDistribution"> <summary> Gets the StreamingDistribution property as a List </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsResponse.Marker"> <summary> Gets and sets the Marker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsResponse.MaxItems"> <summary> Gets and sets the MaxItems property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsResponse.NextMarker"> <summary> Gets and sets the NextMarker property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.ListStreamingDistributionsResponse.IsTruncated"> <summary> Gets and sets the IsTruncated property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest"> <summary> The PostInvalidationRequest contains the parameters used for the PostInvalidation operation. <br />Required Parameter: DistributionId, InvalidationBatch.CallerReference </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest.#ctor(Amazon.CloudFront_2012_03_15.Model.InvalidationBatch)"> <summary> Constructs and instance of PostInvalidationRequest with an InvalidationBatch which will be set to the InvalidationBatch property. </summary> <param name="invalidationBatch">The InvalidationBatch property that will be set to the InvalidationBatch property.</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest.WithDistribtionId(System.String)"> <summary> Sets the DistributionId property of this request to the value passed in. </summary> <param name="distributionId">The distribution's id</param> <returns>The request with the DistributionId property set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest.WithInvalidationBatch(Amazon.CloudFront_2012_03_15.Model.InvalidationBatch)"> <summary> Sets the InvalidationBatch property of this request to the value passed in. </summary> <param name="invalidationBatch">An InvalidationBatch object that lists all the paths of objects to be invalidated.</param> <returns>The request with the InvalidationBatch property set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest.DistributionId"> <summary> Gets and Sets the DistributionId property for the Distribution </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.PostInvalidationRequest.InvalidationBatch"> <summary> Gets and Sets the InvalidationBatch which contains the list of objects to invalidated. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.PostInvalidationResponse.Status"> <summary> Gets and Sets the Status property. Valid Values are InProgress and Completed </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.PostInvalidationResponse.Id"> <summary> Gets and Sets the Id property which is the invalidation id </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.PostInvalidationResponse.CreateTime"> <summary> Gets and Sets the CreateTime property which is the date and time the invalidation request was first made. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.PostInvalidationResponse.InvalidationBatch"> <summary> Gets and Sets the InvalidationBatch property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.S3Origin"> <summary> S3 origin information to associate with the distribution. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.S3Origin.#ctor"> <summary> Initializes a new instance of the S3Origin class. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.S3Origin.#ctor(System.String,Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity)"> <summary> Initializes a new instance of the S3Origin class. </summary> <param name="dnsName">The DNS name of your Amazon S3 bucket.</param> <param name="originAccessIdentity">The origin access identity.</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.S3Origin.WithDNSName(System.String)"> <summary> Sets the DNS name of your Amazon S3 bucket to associate with the distribution and returns back this instance for method chaining. </summary> <param name="dnsName">The DNS name of your Amazon S3 bucket.</param> <returns>This instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.S3Origin.WithOriginAccessIdentity(Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentity)"> <summary> Sets the CloudFront origin access identity to associate with the distribution. When the distribution is serving private content this property must be set. This instance is returned back for method chaining. </summary> <param name="originAccessIdentity">The origin access identity.</param> <returns>This instance</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.S3Origin.DNSName"> <summary> Gets or sets the DNS name of your Amazon S3 bucket to associate with the distribution. For example: mybucket.s3.amazonaws.com. </summary> <value>The DNS name of your Amazon S3 bucket.</value> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.S3Origin.OriginAccessIdentity"> <summary> Gets or sets the CloudFront origin access identity to associate with the distribution. When the distribution is serving private content this property must be set. </summary> <value>The origin access identity.</value> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest"> <summary> The SetDistributionConfigRequest contains the parameters used for the SetDistributionConfig operation. The ETag parameter is used if you wish to specify the ETag to match with the ETag of the Distribution with the Id specified. <br />Required Parameters: Id <br />Required Parameters: DistributionConfig <br />Required Parameters: ETag of the Distribution. This can be retrieved via a call to GetDistibutionInfo </summary> <remarks> If you want to serve private content, you need to: <list type="bullet"> <item>Associate an Origin Access Identity with the DistributionConfig</item> <item>Associate TrustedSigners with the DistributionConfig if you want to serve content via Signed URLs</item> </list> </remarks> <seealso cref="T:Amazon.CloudFront.Model.CloudFrontDistributionConfig"/> <seealso cref="T:Amazon.CloudFront.Model.UrlTrustedSigners"/> <seealso cref="P:Amazon.CloudFront.Model.CloudFrontDistributionConfig.OriginAccessIdentity"/> <seealso cref="P:Amazon.CloudFront.Model.CloudFrontDistributionConfig.TrustedSigners"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest.WithId(System.String)"> <summary> Sets the Id property for this request. This is the CloudFront Distribution Id that will be reconfigured by this request. </summary> <param name="id">The value that Id is set to</param> <returns>the request with the Id set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest.WithDistributionConfig(Amazon.CloudFront_2012_03_15.Model.CloudFrontDistributionConfig)"> <summary> Sets the DistributionConfig property for this request. </summary> <param name="distributionConfig">The value that DistributionConfig is set to</param> <returns>the request with the Configuration set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest.WithETag(System.String)"> <summary> Sets the ETag property for this request. This is the ETag of the CloudFront Distribution which will be reconfigured. </summary> <param name="etag">The value that ETag is set to</param> <returns>the request with the ETag set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest.Id"> <summary> Gets and sets the Id property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest.DistributionConfig"> <summary> Gets and Sets the DistributionConfig property. The CloudFront Distribution's configuration will be modified to reflect the values in this configuration object. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigRequest.ETag"> <summary> Gets and sets the ETag property. This should be the ETag of the Distribution. <see cref="P:Amazon.CloudFront.Model.CloudFrontDistribution.ETag"/> </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigResponse"> <summary> The SetDistributionConfigResponse contains the distribution's modified information structure along with any other headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetDistributionConfigResponse.ETag"> <summary> Gets and sets the ETag property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest"> <summary> The SetOriginAccessIdentityConfigRequest contains the parameters used for the SetOriginAccessIdentityConfig operation. <br />Required Parameters: Id <br />Required Parameters: OriginAccessIdentityConfig <br />Required Parameters: ETag of the Origin Access Identity. This value can be retrieved via a call to GetOriginAccessIdentityInfo. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest.WithId(System.String)"> <summary> Sets the Id property for this request. This is the Id of the CloudFront Origin Access Identity that will be reconfigured by this request. </summary> <param name="id">The value that Id is set to</param> <returns>the request with the Id set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest.WithOriginAccessIdentityConfig(Amazon.CloudFront_2012_03_15.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Sets the OriginAccessIdentityConfig property for this request. </summary> <param name="config">The value that OriginAccessIdentityConfig is set to</param> <returns>the request with the Configuration set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest.IsSetOriginAccessIdentityConfig"> <summary> Checks if DistributionConfig property is set. </summary> <returns>true if DistributionConfig property is set.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest.WithETag(System.String)"> <summary> Sets the ETag property for this request. This is the ETag of the CloudFront Origin Access Identity which will be reconfigured. </summary> <param name="etag">The value that ETag is set to</param> <returns>the request with the ETag set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest.Id"> <summary> Gets and sets the Id property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest.OriginAccessIdentityConfig"> <summary> Gets and Sets the OriginAccessIdentityConfig property. The CloudFront Origin Access Identity's configuration will be modified to reflect the values in this configuration object. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigRequest.ETag"> <summary> Gets and sets the ETag property. This value should be the ETag of the Origin Access Identity. <see cref="P:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity.ETag"/> </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigResponse"> <summary> The SetOriginAccessIdentityConfigResponse contains the Origin Access Identity's modified information structure along with any other headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetOriginAccessIdentityConfigResponse.ETag"> <summary> Gets and sets the ETag property. The Distribution's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest"> <summary> The SetStreamingDistributionConfigRequest contains the parameters used for the SetStreamingDistributionConfig operation. The ETag parameter is used if you wish to specify the ETag to match with the ETag of the StreamingDistribution with the Id specified. <br />Required Parameters: Id <br />Required Parameters: StreamingDistributionConfig <br />Required Parameters: ETag of the Streaming Distribution. This value can be retrieved via a call to GetStreamingDistributionInfo. </summary> <remarks> If you want to serve private content, you need to: <list type="bullet"> <item>Associate an Origin Access Identity with the StreamingDistributionConfig</item> <item>Associate TrustedSigners with the StreamingDistributionConfig if you want to serve content via Signed URLs</item> </list> </remarks> <seealso cref="T:Amazon.CloudFront.Model.CloudFrontStreamingDistributionConfig"/> <seealso cref="T:Amazon.CloudFront.Model.UrlTrustedSigners"/> <seealso cref="P:Amazon.CloudFront.Model.CloudFrontStreamingDistributionConfig.OriginAccessIdentity"/> <seealso cref="P:Amazon.CloudFront.Model.CloudFrontStreamingDistributionConfig.TrustedSigners"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest.WithId(System.String)"> <summary> Sets the Id property for this request. This is the CloudFront Streaming Distribution Id that will be reconfigured by this request. </summary> <param name="id">The value that Id is set to</param> <returns>the request with the Id set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest.WithStreamingDistributionConfig(Amazon.CloudFront_2012_03_15.Model.CloudFrontStreamingDistributionConfig)"> <summary> Sets the StreamingDistributionConfig property for this request. </summary> <param name="config">The value that StreamingDistributionConfig is set to</param> <returns>the request with the Configuration set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest.WithETag(System.String)"> <summary> Sets the ETag property for this request. This is the ETag of the CloudFront Streaming Distribution which will be reconfigured. </summary> <param name="etag">The value that ETag is set to</param> <returns>the request with the ETag set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest.Id"> <summary> Gets and sets the Id property. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest.StreamingDistributionConfig"> <summary> Gets and Sets the StreamingDistributionConfig property. The CloudFront Streaming Distribution's configuration will be modified to reflect the values in this configuration object. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigRequest.ETag"> <summary> Gets and sets the ETag property. This should be the ETag of the Streaming Distribution. <see cref="P:Amazon.CloudFront.Model.CloudFrontStreamingDistribution.ETag"/> </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigResponse"> <summary> The SetStreamingDistributionConfigResponse contains the distribution's modified information structure along with any other headers returned by CloudFront. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.SetStreamingDistributionConfigResponse.ETag"> <summary> Gets and sets the ETag property. The Distribution's ETag is also set if possible. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.Signer"> <summary> The Signer complex type specifies an AWS accounts that has permission to create signed URLs for private content. The Accounts that have signing privileges are specified in the DistributionConfig complex type and can be set using the SetDistributionConfig CloudFront operation. A signer can be: <list type="number"> <item>Yourself (you must explicitly give yourself permission). <see cref="P:Amazon.CloudFront.Model.UrlTrustedSigners.EnableSelf"/> </item> <item>An AwsAccountNumber for each AWS account (other than your own) that you is given signing authority. The account number has no dashes. <see cref="P:Amazon.CloudFront.Model.UrlTrustedSigners.AwsAccountNumbers"/> </item> </list> The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs. </summary> <seealso cref="M:Amazon.CloudFront.AmazonCloudFrontClient.SetDistributionConfig" /> <seealso cref="T:Amazon.CloudFront.Model.CloudFrontDistributionConfig"/> <seealso href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.Signer.IsSetKeypairId"> <summary> Checks if KeyPairId property is set </summary> <returns>true if KeyPairId property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.Signer.IsSetAwsAccountNumber"> <summary> Checks if AwsAccountNumber property is set </summary> <returns>true if AwsAccountNumber property is set</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.Signer.KeyPairId"> <summary> Gets and Sets the KeyPairId property. A list of the KeyPairId for the AWS account that has URL signing authority. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.Signer.Self"> <summary> Gets and sets the Self property. Whether this Signer specifies "your" account. </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.Signer.AwsAccountNumber"> <summary> Gets and sets the AwsAccountNumber property. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.Tuple`2"> <summary> Creates a Key Value pair relating the key and value of type T and U respectively </summary> <typeparam name="T">The type of the key</typeparam> <typeparam name="U">The type of the value</typeparam> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.Tuple`2.#ctor"> <summary> The default constructor </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.Tuple`2.#ctor(`0,`1)"> <summary> Constructs a Tuple relating an instance of type T to an instance of type U </summary> <param name="first">The key</param> <param name="second">The value</param> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.Tuple`2.GetHashCode"> <summary> Returns the hash code for this tuple </summary> <returns>A 32-bit signed integer hash code</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.Tuple`2.Equals(System.Object)"> <summary> Determines whether two Tuple objects have the same value. </summary> <param name="obj"></param> <returns>true if obj is a String and its value is the same as this instance; otherwise, false.</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.Tuple`2.Equals(Amazon.CloudFront_2012_03_15.Model.Tuple{`0,`1})"> <summary> Determines whether two Tuple objects have the same value. </summary> <param name="other"></param> <returns>true if obj is a String and its value is the same as this instance; otherwise, false.</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.Tuple`2.First"> <summary> Returns the key of this Tuple </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.Tuple`2.Second"> <summary> Returns the value of this Tuple </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners"> <summary> The UrlTrustedSigners complex type specifies any AWS accounts you want to permit to create signed URLs for private content. To specify who can sign URLs <list type="number"> <item>Enable yourself to be a trusted signer (you must explicitly give yourself permission). <see cref="P:Amazon.CloudFront.Model.UrlTrustedSigners.EnableSelf"/> </item> <item>Add an AwsAccountNumber for each AWS account (other than your own) that you want to give signing authority (limit of five). Remove the dashes from the account number. <see cref="P:Amazon.CloudFront.Model.UrlTrustedSigners.AwsAccountNumbers"/> </item> </list> If you want the distribution to use signed URLs, include this element in the DistributionConfig for your CloudFront distribution either while creating the distribution or by updating the distribution's config. For more information, please visit: <see href="http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DistributionConfigDatatype.html"/> </summary> <seealso cref="M:Amazon.CloudFront.AmazonCloudFrontClient.SetDistributionConfig" /> <seealso cref="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateDistribution"/> <seealso cref="T:Amazon.CloudFront.Model.CloudFrontDistributionConfig"/> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners.ToString"> <summary> Creates an string representation of the UrlTrustedSigners object by overriding the default Object ToString method. This string can be concatenated to the distribution config xml that is sent to CloudFront while creating a distribution or updating a distribution's configuration. </summary> <returns> String representation of the UrlTrustedSigners type. </returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners.WithAwsAccountNumbers(System.String[])"> <summary> Sets the AwsAccountNumbers property. Please provide the AWS account number without dashes. If you set more than 5 trusted signers for URLs, a <code>TooManyTrustedSigners</code> exception will be returned by CloudFront. </summary> <param name="awsAccounts">Value that the AwsAccountNumbers property will be set to</param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners.IsSetAwsAccounts"> <summary> Checks if AwsAccountNumbers property is set </summary> <returns>true if AwsAccountNumbers property is set</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners.WithEnableSelf(System.Boolean)"> <summary> Sets the EnableSelf property </summary> <param name="enableSelf">EnableSelf property</param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners.AwsAccountNumbers"> <summary> Gets and sets the AwsAccountNumbers property. A list of the AwsAccountNumbers for each AWS account (other than your own) that you want to give URL signing authority to (limit of five). </summary> </member> <member name="P:Amazon.CloudFront_2012_03_15.Model.UrlTrustedSigners.EnableSelf"> <summary> Gets and sets the EnableSelf property. Whether your own AWS account is authorized to sign URLs. Default - your AWS account is not authorized to sign URLs. </summary> </member> <member name="T:Amazon.CloudFront_2012_03_15.Util.AmazonCloudFrontUtil"> <summary> Provides utilities used by the Amazon CloudFront client implementation. </summary> </member> <member name="M:Amazon.CloudFront_2012_03_15.Util.AmazonCloudFrontUtil.CreateHeaderEntry(System.String,System.String)"> <summary> Builds and returns the name value collection that can be added to the HTTP headers for the request </summary> <param name="key">The key to be added to the headers (eg. Content-Body)</param> <param name="value">The value of the key being added</param> <returns>A NameValueCollection with just one key-value pair</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Util.AmazonCloudFrontUtil.Sign(System.String,System.Security.SecureString,System.Security.Cryptography.KeyedHashAlgorithm)"> <summary> Computes RFC 2104-compliant HMAC signature </summary> <param name="data">The data to be signed</param> <param name="key">The secret signing key</param> <param name="algorithm">The algorithm to sign the data with</param> <returns>A string representing the HMAC signature</returns> </member> <member name="M:Amazon.CloudFront_2012_03_15.Util.AmazonCloudFrontUtil.UrlEncode(System.String,System.Boolean)"> <summary> URL encodes a string. If the path property is specified, the accepted characters {/:+} are not encoded. </summary> <param name="data">The string to encode</param> <param name="path">Whether the string is a URL path or not</param> <returns></returns> </member> <member name="P:Amazon.CloudFront_2012_03_15.Util.AmazonCloudFrontUtil.FormattedCurrentTimestamp"> <summary> Formats the current date as a GMT timestamp </summary> <returns>A GMT formatted string representation of the current date and time </returns> </member> <member name="T:Amazon.CloudSearch.AmazonCloudSearch"> <summary> Interface for accessing AmazonCloudSearch. 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" >Regions and Endpoints</a> .</para> </summary> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"> <summary> <para>Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <c>text</c> 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 <c>Deployed</c> option to <c>true</c> 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">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeAnalysisSchemesRequest">Container for the necessary parameters to execute the DescribeAnalysisSchemes service method on AmazonCloudSearch.</param> <returns>The response from the DescribeAnalysisSchemes service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAnalysisSchemes operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"/> </summary> <param name="describeAnalysisSchemesRequest">Container for the necessary parameters to execute the DescribeAnalysisSchemes operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAnalysisSchemes operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeAnalysisSchemes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAnalysisSchemes operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAnalysisSchemes.</param> <returns>Returns a DescribeAnalysisSchemesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"> <summary> <para>Removes an <c> IndexField </c> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DeleteIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"/> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDeleteIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"> <summary> <para>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">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="updateAvailabilityOptionsRequest">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginUpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"/> </summary> <param name="updateAvailabilityOptionsRequest">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAvailabilityOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndUpdateAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAvailabilityOptions.</param> <returns>Returns a UpdateAvailabilityOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields service method on AmazonCloudSearch.</param> <returns>The response from the DescribeIndexFields service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIndexFields operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeIndexFields(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"> <summary> <para>Configures an <c> Expression </c> 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">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="defineExpressionRequest">Container for the necessary parameters to execute the DefineExpression service method on AmazonCloudSearch.</param> <returns>The response from the DefineExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"/> </summary> <param name="defineExpressionRequest">Container for the necessary parameters to execute the DefineExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDefineExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineExpression.</param> <returns>Returns a DefineExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"> <summary> <para>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"> Configuring Access for an Amazon CloudSearch Domain</a> .</para> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndUpdateServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"> <summary> <para>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-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="defineSuggesterRequest">Container for the necessary parameters to execute the DefineSuggester service method on AmazonCloudSearch.</param> <returns>The response from the DefineSuggester service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"/> </summary> <param name="defineSuggesterRequest">Container for the necessary parameters to execute the DefineSuggester operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineSuggester operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDefineSuggester(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineSuggester.</param> <returns>Returns a DefineSuggesterResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"> <summary> <para>Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html.html">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="deleteAnalysisSchemeRequest">Container for the necessary parameters to execute the DeleteAnalysisScheme service method on AmazonCloudSearch.</param> <returns>The response from the DeleteAnalysisScheme service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"/> </summary> <param name="deleteAnalysisSchemeRequest">Container for the necessary parameters to execute the DeleteAnalysisScheme operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAnalysisScheme operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDeleteAnalysisScheme(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAnalysisScheme.</param> <returns>Returns a DeleteAnalysisSchemeResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"> <summary> <para>Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is <c>RequiresIndexDocuments</c> .</para> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments service method on AmazonCloudSearch.</param> <returns>The response from the IndexDocuments service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginIndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"/> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndIndexDocuments operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndIndexDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeSuggestersRequest">Container for the necessary parameters to execute the DescribeSuggesters service method on AmazonCloudSearch.</param> <returns>The response from the DescribeSuggesters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"/> </summary> <param name="describeSuggestersRequest">Container for the necessary parameters to execute the DescribeSuggesters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSuggesters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeSuggesters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSuggesters.</param> <returns>Returns a DescribeSuggestersResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"> <summary> <para>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">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="updateScalingParametersRequest">Container for the necessary parameters to execute the UpdateScalingParameters service method on AmazonCloudSearch.</param> <returns>The response from the UpdateScalingParameters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginUpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"/> </summary> <param name="updateScalingParametersRequest">Container for the necessary parameters to execute the UpdateScalingParameters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateScalingParameters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndUpdateScalingParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateScalingParameters.</param> <returns>Returns a UpdateScalingParametersResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"> <summary> <para>Lists all search domains owned by an account.</para> </summary> <param name="listDomainNamesRequest">Container for the necessary parameters to execute the ListDomainNames service method on AmazonCloudSearch.</param> <returns>The response from the ListDomainNames service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDomainNames operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"/> </summary> <param name="listDomainNamesRequest">Container for the necessary parameters to execute the ListDomainNames operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDomainNames operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndListDomainNames(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDomainNames operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDomainNames.</param> <returns>Returns a ListDomainNamesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.ListDomainNames"> <summary> <para>Lists all search domains owned by an account.</para> </summary> <returns>The response from the ListDomainNames service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"> <summary> <para>Configures an <c> IndexField </c> 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 <c> IndexFieldType </c> . 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">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DefineIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"/> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDefineIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"> <summary> <para>Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain service method on AmazonCloudSearch.</param> <returns>The response from the CreateDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginCreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"/> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndCreateDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"> <summary> <para>Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="deleteSuggesterRequest">Container for the necessary parameters to execute the DeleteSuggester service method on AmazonCloudSearch.</param> <returns>The response from the DeleteSuggester service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"/> </summary> <param name="deleteSuggesterRequest">Container for the necessary parameters to execute the DeleteSuggester operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSuggester operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDeleteSuggester(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSuggester.</param> <returns>Returns a DeleteSuggesterResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"> <summary> <para>Removes an <c> Expression </c> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="deleteExpressionRequest">Container for the necessary parameters to execute the DeleteExpression service method on AmazonCloudSearch.</param> <returns>The response from the DeleteExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"/> </summary> <param name="deleteExpressionRequest">Container for the necessary parameters to execute the DeleteExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDeleteExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteExpression.</param> <returns>Returns a DeleteExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"> <summary> <para>Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <c>Deployed</c> option to <c>true</c> 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">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeAvailabilityOptionsRequest">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"/> </summary> <param name="describeAvailabilityOptionsRequest">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAvailabilityOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityOptions.</param> <returns>Returns a DescribeAvailabilityOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"> <summary> <para>Configures an analysis scheme for a domain. An analysis scheme defines language-specific text processing options for a <c>text</c> field. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="defineAnalysisSchemeRequest">Container for the necessary parameters to execute the DefineAnalysisScheme service method on AmazonCloudSearch.</param> <returns>The response from the DefineAnalysisScheme service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"/> </summary> <param name="defineAnalysisSchemeRequest">Container for the necessary parameters to execute the DefineAnalysisScheme operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineAnalysisScheme operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDefineAnalysisScheme(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineAnalysisScheme.</param> <returns>Returns a DefineAnalysisSchemeResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"> <summary> <para>Indexes the search suggestions. </para> </summary> <param name="buildSuggestersRequest">Container for the necessary parameters to execute the BuildSuggesters service method on AmazonCloudSearch.</param> <returns>The response from the BuildSuggesters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginBuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BuildSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"/> </summary> <param name="buildSuggestersRequest">Container for the necessary parameters to execute the BuildSuggesters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBuildSuggesters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndBuildSuggesters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BuildSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBuildSuggesters.</param> <returns>Returns a BuildSuggestersResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> 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">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"> <summary> <para>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">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain service method on AmazonCloudSearch.</param> <returns>The response from the DeleteDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"/> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDeleteDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> 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">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeExpressionsRequest">Container for the necessary parameters to execute the DescribeExpressions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeExpressions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExpressions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"/> </summary> <param name="describeExpressionsRequest">Container for the necessary parameters to execute the DescribeExpressions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeExpressions operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeExpressions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeExpressions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExpressions.</param> <returns>Returns a DescribeExpressionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains service method on AmazonCloudSearch.</param> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"/> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDomains operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeDomains(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeDomains"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"> <summary> <para>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">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeScalingParametersRequest">Container for the necessary parameters to execute the DescribeScalingParameters service method on AmazonCloudSearch.</param> <returns>The response from the DescribeScalingParameters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.BeginDescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"/> </summary> <param name="describeScalingParametersRequest">Container for the necessary parameters to execute the DescribeScalingParameters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScalingParameters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearch.EndDescribeScalingParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingParameters.</param> <returns>Returns a DescribeScalingParametersResult from AmazonCloudSearch.</returns> </member> <member name="T:Amazon.CloudSearch.AmazonCloudSearchClient"> <summary> Implementation for accessing AmazonCloudSearch. 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" >Regions and Endpoints</a> .</para> </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearch 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"> <summary> <para>Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <c>text</c> 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 <c>Deployed</c> option to <c>true</c> 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">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeAnalysisSchemesRequest">Container for the necessary parameters to execute the DescribeAnalysisSchemes service method on AmazonCloudSearch.</param> <returns>The response from the DescribeAnalysisSchemes service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAnalysisSchemes operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"/> </summary> <param name="describeAnalysisSchemesRequest">Container for the necessary parameters to execute the DescribeAnalysisSchemes operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAnalysisSchemes operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeAnalysisSchemes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAnalysisSchemes operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAnalysisSchemes.</param> <returns>Returns a DescribeAnalysisSchemesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"> <summary> <para>Removes an <c> IndexField </c> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DeleteIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"/> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDeleteIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"> <summary> <para>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">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="updateAvailabilityOptionsRequest">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginUpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"/> </summary> <param name="updateAvailabilityOptionsRequest">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAvailabilityOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndUpdateAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAvailabilityOptions.</param> <returns>Returns a UpdateAvailabilityOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields service method on AmazonCloudSearch.</param> <returns>The response from the DescribeIndexFields service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIndexFields operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeIndexFields(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"> <summary> <para>Configures an <c> Expression </c> 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">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="defineExpressionRequest">Container for the necessary parameters to execute the DefineExpression service method on AmazonCloudSearch.</param> <returns>The response from the DefineExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"/> </summary> <param name="defineExpressionRequest">Container for the necessary parameters to execute the DefineExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDefineExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineExpression.</param> <returns>Returns a DefineExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"> <summary> <para>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"> Configuring Access for an Amazon CloudSearch Domain</a> .</para> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndUpdateServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"> <summary> <para>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-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="defineSuggesterRequest">Container for the necessary parameters to execute the DefineSuggester service method on AmazonCloudSearch.</param> <returns>The response from the DefineSuggester service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"/> </summary> <param name="defineSuggesterRequest">Container for the necessary parameters to execute the DefineSuggester operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineSuggester operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDefineSuggester(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineSuggester.</param> <returns>Returns a DefineSuggesterResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"> <summary> <para>Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html.html">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="deleteAnalysisSchemeRequest">Container for the necessary parameters to execute the DeleteAnalysisScheme service method on AmazonCloudSearch.</param> <returns>The response from the DeleteAnalysisScheme service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"/> </summary> <param name="deleteAnalysisSchemeRequest">Container for the necessary parameters to execute the DeleteAnalysisScheme operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAnalysisScheme operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDeleteAnalysisScheme(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAnalysisScheme.</param> <returns>Returns a DeleteAnalysisSchemeResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"> <summary> <para>Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is <c>RequiresIndexDocuments</c> .</para> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments service method on AmazonCloudSearch.</param> <returns>The response from the IndexDocuments service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginIndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"/> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndIndexDocuments operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndIndexDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeSuggestersRequest">Container for the necessary parameters to execute the DescribeSuggesters service method on AmazonCloudSearch.</param> <returns>The response from the DescribeSuggesters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"/> </summary> <param name="describeSuggestersRequest">Container for the necessary parameters to execute the DescribeSuggesters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSuggesters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeSuggesters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSuggesters.</param> <returns>Returns a DescribeSuggestersResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"> <summary> <para>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">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="updateScalingParametersRequest">Container for the necessary parameters to execute the UpdateScalingParameters service method on AmazonCloudSearch.</param> <returns>The response from the UpdateScalingParameters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginUpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"/> </summary> <param name="updateScalingParametersRequest">Container for the necessary parameters to execute the UpdateScalingParameters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateScalingParameters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndUpdateScalingParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateScalingParameters.</param> <returns>Returns a UpdateScalingParametersResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"> <summary> <para>Lists all search domains owned by an account.</para> </summary> <param name="listDomainNamesRequest">Container for the necessary parameters to execute the ListDomainNames service method on AmazonCloudSearch.</param> <returns>The response from the ListDomainNames service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDomainNames operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"/> </summary> <param name="listDomainNamesRequest">Container for the necessary parameters to execute the ListDomainNames operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDomainNames operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndListDomainNames(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDomainNames operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDomainNames.</param> <returns>Returns a ListDomainNamesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.ListDomainNames"> <summary> <para>Lists all search domains owned by an account.</para> </summary> <returns>The response from the ListDomainNames service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"> <summary> <para>Configures an <c> IndexField </c> 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 <c> IndexFieldType </c> . 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">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DefineIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"/> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDefineIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"> <summary> <para>Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain service method on AmazonCloudSearch.</param> <returns>The response from the CreateDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginCreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"/> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndCreateDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"> <summary> <para>Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="deleteSuggesterRequest">Container for the necessary parameters to execute the DeleteSuggester service method on AmazonCloudSearch.</param> <returns>The response from the DeleteSuggester service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"/> </summary> <param name="deleteSuggesterRequest">Container for the necessary parameters to execute the DeleteSuggester operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSuggester operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDeleteSuggester(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSuggester operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSuggester.</param> <returns>Returns a DeleteSuggesterResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"> <summary> <para>Removes an <c> Expression </c> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="deleteExpressionRequest">Container for the necessary parameters to execute the DeleteExpression service method on AmazonCloudSearch.</param> <returns>The response from the DeleteExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"/> </summary> <param name="deleteExpressionRequest">Container for the necessary parameters to execute the DeleteExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDeleteExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteExpression operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteExpression.</param> <returns>Returns a DeleteExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"> <summary> <para>Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <c>Deployed</c> option to <c>true</c> 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">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeAvailabilityOptionsRequest">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"/> </summary> <param name="describeAvailabilityOptionsRequest">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAvailabilityOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAvailabilityOptions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityOptions.</param> <returns>Returns a DescribeAvailabilityOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"> <summary> <para>Configures an analysis scheme for a domain. An analysis scheme defines language-specific text processing options for a <c>text</c> field. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="defineAnalysisSchemeRequest">Container for the necessary parameters to execute the DefineAnalysisScheme service method on AmazonCloudSearch.</param> <returns>The response from the DefineAnalysisScheme service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"/> </summary> <param name="defineAnalysisSchemeRequest">Container for the necessary parameters to execute the DefineAnalysisScheme operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineAnalysisScheme operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDefineAnalysisScheme(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineAnalysisScheme operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineAnalysisScheme.</param> <returns>Returns a DefineAnalysisSchemeResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"> <summary> <para>Indexes the search suggestions. </para> </summary> <param name="buildSuggestersRequest">Container for the necessary parameters to execute the BuildSuggesters service method on AmazonCloudSearch.</param> <returns>The response from the BuildSuggesters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginBuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BuildSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"/> </summary> <param name="buildSuggestersRequest">Container for the necessary parameters to execute the BuildSuggesters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBuildSuggesters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndBuildSuggesters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BuildSuggesters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBuildSuggesters.</param> <returns>Returns a BuildSuggestersResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> 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">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"> <summary> <para>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">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain service method on AmazonCloudSearch.</param> <returns>The response from the DeleteDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"/> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDeleteDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"> <summary> <para>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 <c>Deployed</c> option to <c>true</c> 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">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeExpressionsRequest">Container for the necessary parameters to execute the DescribeExpressions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeExpressions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExpressions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"/> </summary> <param name="describeExpressionsRequest">Container for the necessary parameters to execute the DescribeExpressions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeExpressions operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeExpressions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeExpressions operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExpressions.</param> <returns>Returns a DescribeExpressionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains service method on AmazonCloudSearch.</param> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"/> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDomains operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeDomains(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeDomains"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"> <summary> <para>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">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <param name="describeScalingParametersRequest">Container for the necessary parameters to execute the DescribeScalingParameters service method on AmazonCloudSearch.</param> <returns>The response from the DescribeScalingParameters service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch.Model.BaseException"/> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"/> </summary> <param name="describeScalingParametersRequest">Container for the necessary parameters to execute the DescribeScalingParameters operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeScalingParameters operation.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.EndDescribeScalingParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingParameters operation. <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingParameters.</param> <returns>Returns a DescribeScalingParametersResult from AmazonCloudSearch.</returns> </member> <member name="T:Amazon.CloudSearch.AmazonCloudSearchConfig"> <summary> Configuration for accessing Amazon CloudSearch Configuration Service service </summary> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudSearch.AmazonCloudSearchConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudSearch.AmazonCloudSearchConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CloudSearch.Model.AccessPoliciesStatus"> <summary> <para>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.AccessPoliciesStatus.WithOptions(System.String)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AccessPoliciesStatus.WithStatus(Amazon.CloudSearch.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.AccessPoliciesStatus.Options"> <summary> Access rules for a domain's document or search service endpoints. 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>. The maximum size of a policy document is 100 KB. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AccessPoliciesStatus.Status"> <summary> The status of domain configuration option. </summary> </member> <member name="T:Amazon.CloudSearch.Model.AnalysisOptions"> <summary> <para>Synonyms, stopwords, and stemming options for an analysis scheme.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisOptions.WithSynonyms(System.String)"> <summary> Sets the Synonyms property </summary> <param name="synonyms">The value to set for the Synonyms property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisOptions.WithStopwords(System.String)"> <summary> Sets the Stopwords property </summary> <param name="stopwords">The value to set for the Stopwords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisOptions.WithStemmingDictionary(System.String)"> <summary> Sets the StemmingDictionary property </summary> <param name="stemmingDictionary">The value to set for the StemmingDictionary property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisOptions.WithAlgorithmicStemming(System.String)"> <summary> Sets the AlgorithmicStemming property </summary> <param name="algorithmicStemming">The value to set for the AlgorithmicStemming property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.Synonyms"> <summary> A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.Stopwords"> <summary> A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.StemmingDictionary"> <summary> A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.AlgorithmicStemming"> <summary> The level of algorithmic stemming to perform: <c>none</c>, <c>minimal</c>, <c>light</c>, or <c>full</c>. The available levels vary depending on the language. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing-settings.html" target="_blank">Langage Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>none, minimal, light, full</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.AnalysisScheme"> <summary> <para>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <c>Synonyms</c> , <c>Stopwords</c> , <c>StemmingDictionary</c> , and <c>AlgorithmicStemming</c> .</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisScheme.WithAnalysisSchemeName(System.String)"> <summary> Sets the AnalysisSchemeName property </summary> <param name="analysisSchemeName">The value to set for the AnalysisSchemeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisScheme.WithAnalysisSchemeLanguage(System.String)"> <summary> Sets the AnalysisSchemeLanguage property </summary> <param name="analysisSchemeLanguage">The value to set for the AnalysisSchemeLanguage property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisScheme.WithAnalysisOptions(Amazon.CloudSearch.Model.AnalysisOptions)"> <summary> Sets the AnalysisOptions property </summary> <param name="analysisOptions">The value to set for the AnalysisOptions property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisScheme.AnalysisSchemeName"> <summary> A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <c>_id</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisScheme.AnalysisSchemeLanguage"> <summary> An <a href="http://tools.ietf.org/html/rfc4646" target="_blank">IETF RFC 4646</a> language code or <c>mul</c> for multiple languages. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisScheme.AnalysisOptions"> <summary> Synonyms, stopwords, and stemming options for an analysis scheme. </summary> </member> <member name="T:Amazon.CloudSearch.Model.AnalysisSchemeStatus"> <summary> <para>The status and configuration of an <c>AnalysisScheme</c> .</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisSchemeStatus.WithOptions(Amazon.CloudSearch.Model.AnalysisScheme)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AnalysisSchemeStatus.WithStatus(Amazon.CloudSearch.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisSchemeStatus.Options"> <summary> Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <c>Synonyms</c>, <c>Stopwords</c>, <c>StemmingDictionary</c>, and <c>AlgorithmicStemming</c>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisSchemeStatus.Status"> <summary> The status of domain configuration option. </summary> </member> <member name="T:Amazon.CloudSearch.Model.AvailabilityOptionsStatus"> <summary> <para>The status and configuration of the domain's availability options.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.AvailabilityOptionsStatus.WithOptions(System.Boolean)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.AvailabilityOptionsStatus.WithStatus(Amazon.CloudSearch.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.AvailabilityOptionsStatus.Options"> <summary> The availability options configured for the domain. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AvailabilityOptionsStatus.Status"> <summary> The status of domain configuration option. </summary> </member> <member name="T:Amazon.CloudSearch.Model.BaseException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch.Model.BaseException.#ctor(System.String)"> <summary> Constructs a new BaseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch.Model.BuildSuggestersRequest"> <summary> Container for the parameters to the BuildSuggesters operation. <para>Indexes the search suggestions. </para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.BuildSuggestersRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.BuildSuggestersRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.BuildSuggestersResponse"> <summary> Returns information about the BuildSuggestersResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.BuildSuggestersResponse.BuildSuggestersResult"> <summary> Gets and sets the BuildSuggestersResult property. The result of a BuildSuggester request. Contains a list of the fields used for suggestions. </summary> </member> <member name="T:Amazon.CloudSearch.Model.BuildSuggestersResult"> <summary> <para>The result of a <c>BuildSuggester</c> request. Contains a list of the fields used for suggestions.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.BuildSuggestersResult.WithFieldNames(System.String[])"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.BuildSuggestersResult.WithFieldNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.BuildSuggestersResult.FieldNames"> <summary> A list of field names. </summary> </member> <member name="T:Amazon.CloudSearch.Model.CreateDomainRequest"> <summary> Container for the parameters to the CreateDomain operation. <para>Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.CreateDomainRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.CreateDomainRequest.DomainName"> <summary> A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.CreateDomainResponse"> <summary> Returns information about the CreateDomainResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.CreateDomainResponse.CreateDomainResult"> <summary> Gets and sets the CreateDomainResult property. The result of a CreateDomainRequest. Contains the status of a newly created domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.CreateDomainResult"> <summary> <para>The result of a <c>CreateDomainRequest</c> . Contains the status of a newly created domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.CreateDomainResult.WithDomainStatus(Amazon.CloudSearch.Model.DomainStatus)"> <summary> Sets the DomainStatus property </summary> <param name="domainStatus">The value to set for the DomainStatus property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.CreateDomainResult.DomainStatus"> <summary> The current status of the search domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DateArrayOptions"> <summary> <para>Options for a field that contains an array of dates. Present if <c>IndexFieldType</c> specifies the field is of type <c>date-array</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DateArrayOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateArrayOptions.WithSourceFields(System.String)"> <summary> Sets the SourceFields property </summary> <param name="sourceFields">The value to set for the SourceFields property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateArrayOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateArrayOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateArrayOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.SourceFields"> <summary> A list of source fields to map to the field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>\s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DateOptions"> <summary> <para>Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if <c>IndexFieldType</c> specifies the field is of type <c>date</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DateOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateOptions.WithSourceField(System.String)"> <summary> Sets the SourceField property </summary> <param name="sourceField">The value to set for the SourceField property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DateOptions.WithSortEnabled(System.Boolean)"> <summary> Sets the SortEnabled property </summary> <param name="sortEnabled">The value to set for the SortEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.SourceField"> <summary> A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <c>_id</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.SortEnabled"> <summary> Whether the field can be used to sort the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest"> <summary> Container for the parameters to the DefineAnalysisScheme operation. <para>Configures an analysis scheme for a domain. An analysis scheme defines language-specific text processing options for a <c>text</c> field. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest.WithAnalysisScheme(Amazon.CloudSearch.Model.AnalysisScheme)"> <summary> Sets the AnalysisScheme property </summary> <param name="analysisScheme">The value to set for the AnalysisScheme property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest.AnalysisScheme"> <summary> Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <c>Synonyms</c>, <c>Stopwords</c>, <c>StemmingDictionary</c>, and <c>AlgorithmicStemming</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineAnalysisSchemeResponse"> <summary> Returns information about the DefineAnalysisSchemeResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeResponse.DefineAnalysisSchemeResult"> <summary> Gets and sets the DefineAnalysisSchemeResult property. The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineAnalysisSchemeResult"> <summary> <para>The result of a <c> DefineAnalysisScheme </c> request. Contains the status of the newly-configured analysis scheme.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DefineAnalysisSchemeResult.WithAnalysisScheme(Amazon.CloudSearch.Model.AnalysisSchemeStatus)"> <summary> Sets the AnalysisScheme property </summary> <param name="analysisScheme">The value to set for the AnalysisScheme property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeResult.AnalysisScheme"> <summary> The status and configuration of an <c>AnalysisScheme</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineExpressionRequest"> <summary> Container for the parameters to the DefineExpression operation. <para>Configures an <c> Expression </c> 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">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DefineExpressionRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DefineExpressionRequest.WithExpression(Amazon.CloudSearch.Model.Expression)"> <summary> Sets the Expression property </summary> <param name="expression">The value to set for the Expression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionRequest.Expression"> <summary> A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineExpressionResponse"> <summary> Returns information about the DefineExpressionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionResponse.DefineExpressionResult"> <summary> Gets and sets the DefineExpressionResult property. The result of a DefineExpression request. Contains the status of the newly-configured expression. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineExpressionResult"> <summary> <para>The result of a <c>DefineExpression</c> request. Contains the status of the newly-configured expression.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DefineExpressionResult.WithExpression(Amazon.CloudSearch.Model.ExpressionStatus)"> <summary> Sets the Expression property </summary> <param name="expression">The value to set for the Expression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionResult.Expression"> <summary> The value of an <c>Expression</c> and its current status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineIndexFieldRequest"> <summary> Container for the parameters to the DefineIndexField operation. <para>Configures an <c> IndexField </c> 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 <c> IndexFieldType </c> . 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">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DefineIndexFieldRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DefineIndexFieldRequest.WithIndexField(Amazon.CloudSearch.Model.IndexField)"> <summary> Sets the IndexField property </summary> <param name="indexField">The value to set for the IndexField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldRequest.IndexField"> <summary> The index field and field options you want to configure. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineIndexFieldResponse"> <summary> Returns information about the DefineIndexFieldResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldResponse.DefineIndexFieldResult"> <summary> Gets and sets the DefineIndexFieldResult property. The result of a DefineIndexField request. Contains the status of the newly-configured index field. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineIndexFieldResult"> <summary> <para>The result of a <c> DefineIndexField </c> request. Contains the status of the newly-configured index field.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DefineIndexFieldResult.WithIndexField(Amazon.CloudSearch.Model.IndexFieldStatus)"> <summary> Sets the IndexField property </summary> <param name="indexField">The value to set for the IndexField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldResult.IndexField"> <summary> The value of an <c>IndexField</c> and its current status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineSuggesterRequest"> <summary> Container for the parameters to the DefineSuggester operation. <para>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-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DefineSuggesterRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DefineSuggesterRequest.WithSuggester(Amazon.CloudSearch.Model.Suggester)"> <summary> Sets the Suggester property </summary> <param name="suggester">The value to set for the Suggester property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterRequest.Suggester"> <summary> Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <c>FuzzyMatching</c>, <c>SortExpression</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineSuggesterResponse"> <summary> Returns information about the DefineSuggesterResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterResponse.DefineSuggesterResult"> <summary> Gets and sets the DefineSuggesterResult property. The result of a DefineSuggester request. Contains the status of the newly-configured suggester. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineSuggesterResult"> <summary> <para>The result of a <c>DefineSuggester</c> request. Contains the status of the newly-configured suggester.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DefineSuggesterResult.WithSuggester(Amazon.CloudSearch.Model.SuggesterStatus)"> <summary> Sets the Suggester property </summary> <param name="suggester">The value to set for the Suggester property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterResult.Suggester"> <summary> The value of a <c>Suggester</c> and its current status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest"> <summary> Container for the parameters to the DeleteAnalysisScheme operation. <para>Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html.html">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest.WithAnalysisSchemeName(System.String)"> <summary> Sets the AnalysisSchemeName property </summary> <param name="analysisSchemeName">The value to set for the AnalysisSchemeName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest.AnalysisSchemeName"> <summary> The name of the analysis scheme you want to delete. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResponse"> <summary> Returns information about the DeleteAnalysisSchemeResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResponse.DeleteAnalysisSchemeResult"> <summary> Gets and sets the DeleteAnalysisSchemeResult property. The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResult"> <summary> <para>The result of a <c>DeleteAnalysisScheme</c> request. Contains the status of the deleted analysis scheme.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResult.WithAnalysisScheme(Amazon.CloudSearch.Model.AnalysisSchemeStatus)"> <summary> Sets the AnalysisScheme property </summary> <param name="analysisScheme">The value to set for the AnalysisScheme property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResult.AnalysisScheme"> <summary> The status of the analysis scheme being deleted. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteDomainRequest"> <summary> Container for the parameters to the DeleteDomain operation. <para>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">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DeleteDomainRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteDomainRequest.DomainName"> <summary> The name of the domain you want to permanently delete. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteDomainResponse"> <summary> Returns information about the DeleteDomainResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteDomainResponse.DeleteDomainResult"> <summary> Gets and sets the DeleteDomainResult property. The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteDomainResult"> <summary> <para>The result of a <c>DeleteDomain</c> request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DeleteDomainResult.WithDomainStatus(Amazon.CloudSearch.Model.DomainStatus)"> <summary> Sets the DomainStatus property </summary> <param name="domainStatus">The value to set for the DomainStatus property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteDomainResult.DomainStatus"> <summary> The current status of the search domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteExpressionRequest"> <summary> Container for the parameters to the DeleteExpression operation. <para>Removes an <c> Expression </c> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DeleteExpressionRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DeleteExpressionRequest.WithExpressionName(System.String)"> <summary> Sets the ExpressionName property </summary> <param name="expressionName">The value to set for the ExpressionName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionRequest.ExpressionName"> <summary> The name of the <c><a>Expression</a></c> to delete. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteExpressionResponse"> <summary> Returns information about the DeleteExpressionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionResponse.DeleteExpressionResult"> <summary> Gets and sets the DeleteExpressionResult property. The result of a DeleteExpression request. Specifies the expression being deleted. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteExpressionResult"> <summary> <para>The result of a <c> DeleteExpression </c> request. Specifies the expression being deleted.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DeleteExpressionResult.WithExpression(Amazon.CloudSearch.Model.ExpressionStatus)"> <summary> Sets the Expression property </summary> <param name="expression">The value to set for the Expression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionResult.Expression"> <summary> The status of the expression being deleted. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteIndexFieldRequest"> <summary> Container for the parameters to the DeleteIndexField operation. <para>Removes an <c> IndexField </c> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DeleteIndexFieldRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DeleteIndexFieldRequest.WithIndexFieldName(System.String)"> <summary> Sets the IndexFieldName property </summary> <param name="indexFieldName">The value to set for the IndexFieldName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldRequest.IndexFieldName"> <summary> The name of the index field your want to remove from the domain's indexing options. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteIndexFieldResponse"> <summary> Returns information about the DeleteIndexFieldResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldResponse.DeleteIndexFieldResult"> <summary> Gets and sets the DeleteIndexFieldResult property. The result of a DeleteIndexField request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteIndexFieldResult"> <summary> <para>The result of a <c> DeleteIndexField </c> request.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DeleteIndexFieldResult.WithIndexField(Amazon.CloudSearch.Model.IndexFieldStatus)"> <summary> Sets the IndexField property </summary> <param name="indexField">The value to set for the IndexField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldResult.IndexField"> <summary> The status of the index field being deleted. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteSuggesterRequest"> <summary> Container for the parameters to the DeleteSuggester operation. <para>Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DeleteSuggesterRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DeleteSuggesterRequest.WithSuggesterName(System.String)"> <summary> Sets the SuggesterName property </summary> <param name="suggesterName">The value to set for the SuggesterName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterRequest.SuggesterName"> <summary> Specifies the name of the suggester you want to delete. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteSuggesterResponse"> <summary> Returns information about the DeleteSuggesterResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterResponse.DeleteSuggesterResult"> <summary> Gets and sets the DeleteSuggesterResult property. The result of a DeleteSuggester request. Contains the status of the deleted suggester. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteSuggesterResult"> <summary> <para>The result of a <c>DeleteSuggester</c> request. Contains the status of the deleted suggester.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DeleteSuggesterResult.WithSuggester(Amazon.CloudSearch.Model.SuggesterStatus)"> <summary> Sets the Suggester property </summary> <param name="suggester">The value to set for the Suggester property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterResult.Suggester"> <summary> The status of the suggester being deleted. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest"> <summary> Container for the parameters to the DescribeAnalysisSchemes operation. <para>Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <c>text</c> 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 <c>Deployed</c> option to <c>true</c> 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">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.WithAnalysisSchemeNames(System.String[])"> <summary> Adds elements to the AnalysisSchemeNames collection </summary> <param name="analysisSchemeNames">The values to add to the AnalysisSchemeNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.WithAnalysisSchemeNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AnalysisSchemeNames collection </summary> <param name="analysisSchemeNames">The values to add to the AnalysisSchemeNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.WithDeployed(System.Boolean)"> <summary> Sets the Deployed property </summary> <param name="deployed">The value to set for the Deployed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.DomainName"> <summary> The name of the domain you want to describe. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.AnalysisSchemeNames"> <summary> The analysis schemes you want to describe. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.Deployed"> <summary> Whether to display the deployed configuration (<c>true</c>) or include any pending changes (<c>false</c>). Defaults to <c>false</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResponse"> <summary> Returns information about the DescribeAnalysisSchemesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResponse.DescribeAnalysisSchemesResult"> <summary> Gets and sets the DescribeAnalysisSchemesResult property. The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResult"> <summary> <para>The result of a <c>DescribeAnalysisSchemes</c> request. Contains the analysis schemes configured for the domain specified in the request.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResult.WithAnalysisSchemes(Amazon.CloudSearch.Model.AnalysisSchemeStatus[])"> <summary> Adds elements to the AnalysisSchemes collection </summary> <param name="analysisSchemes">The values to add to the AnalysisSchemes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResult.WithAnalysisSchemes(System.Collections.Generic.IEnumerable{Amazon.CloudSearch.Model.AnalysisSchemeStatus})"> <summary> Adds elements to the AnalysisSchemes collection </summary> <param name="analysisSchemes">The values to add to the AnalysisSchemes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResult.AnalysisSchemes"> <summary> The analysis scheme descriptions. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest"> <summary> Container for the parameters to the DescribeAvailabilityOptions operation. <para>Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <c>Deployed</c> option to <c>true</c> 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">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest.WithDeployed(System.Boolean)"> <summary> Sets the Deployed property </summary> <param name="deployed">The value to set for the Deployed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest.DomainName"> <summary> The name of the domain you want to describe. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest.Deployed"> <summary> Whether to display the deployed configuration (<c>true</c>) or include any pending changes (<c>false</c>). Defaults to <c>false</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResponse"> <summary> Returns information about the DescribeAvailabilityOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResponse.DescribeAvailabilityOptionsResult"> <summary> Gets and sets the DescribeAvailabilityOptionsResult property. The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResult"> <summary> <para>The result of a <c>DescribeAvailabilityOptions</c> request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResult.WithAvailabilityOptions(Amazon.CloudSearch.Model.AvailabilityOptionsStatus)"> <summary> Sets the AvailabilityOptions property </summary> <param name="availabilityOptions">The value to set for the AvailabilityOptions property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResult.AvailabilityOptions"> <summary> The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeDomainsRequest"> <summary> Container for the parameters to the DescribeDomains operation. <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeDomainsRequest.WithDomainNames(System.String[])"> <summary> Adds elements to the DomainNames collection </summary> <param name="domainNames">The values to add to the DomainNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeDomainsRequest.WithDomainNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the DomainNames collection </summary> <param name="domainNames">The values to add to the DomainNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeDomainsRequest.DomainNames"> <summary> The names of the domains you want to include in the response. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeDomainsResponse"> <summary> Returns information about the DescribeDomainsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeDomainsResponse.DescribeDomainsResult"> <summary> Gets and sets the DescribeDomainsResult property. The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeDomainsResult"> <summary> <para>The result of a <c>DescribeDomains</c> request. Contains the status of the domains specified in the request or all domains owned by the account.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeDomainsResult.WithDomainStatusList(Amazon.CloudSearch.Model.DomainStatus[])"> <summary> Adds elements to the DomainStatusList collection </summary> <param name="domainStatusList">The values to add to the DomainStatusList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeDomainsResult.WithDomainStatusList(System.Collections.Generic.IEnumerable{Amazon.CloudSearch.Model.DomainStatus})"> <summary> Adds elements to the DomainStatusList collection </summary> <param name="domainStatusList">The values to add to the DomainStatusList collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeDomainsResult.DomainStatusList"> <summary> A list that contains the status of each requested domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeExpressionsRequest"> <summary> Container for the parameters to the DescribeExpressions operation. <para>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 <c>Deployed</c> option to <c>true</c> 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">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeExpressionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeExpressionsRequest.WithExpressionNames(System.String[])"> <summary> Adds elements to the ExpressionNames collection </summary> <param name="expressionNames">The values to add to the ExpressionNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeExpressionsRequest.WithExpressionNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the ExpressionNames collection </summary> <param name="expressionNames">The values to add to the ExpressionNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeExpressionsRequest.WithDeployed(System.Boolean)"> <summary> Sets the Deployed property </summary> <param name="deployed">The value to set for the Deployed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsRequest.DomainName"> <summary> The name of the domain you want to describe. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsRequest.ExpressionNames"> <summary> Limits the <c><a>DescribeExpressions</a></c> response to the specified expressions. If not specified, all expressions are shown. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsRequest.Deployed"> <summary> Whether to display the deployed configuration (<c>true</c>) or include any pending changes (<c>false</c>). Defaults to <c>false</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeExpressionsResponse"> <summary> Returns information about the DescribeExpressionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsResponse.DescribeExpressionsResult"> <summary> Gets and sets the DescribeExpressionsResult property. The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeExpressionsResult"> <summary> <para>The result of a <c>DescribeExpressions</c> request. Contains the expressions configured for the domain specified in the request.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeExpressionsResult.WithExpressions(Amazon.CloudSearch.Model.ExpressionStatus[])"> <summary> Adds elements to the Expressions collection </summary> <param name="expressions">The values to add to the Expressions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeExpressionsResult.WithExpressions(System.Collections.Generic.IEnumerable{Amazon.CloudSearch.Model.ExpressionStatus})"> <summary> Adds elements to the Expressions collection </summary> <param name="expressions">The values to add to the Expressions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsResult.Expressions"> <summary> The expressions configured for the domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest"> <summary> Container for the parameters to the DescribeIndexFields operation. <para>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 <c>Deployed</c> option to <c>true</c> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getdomainstatus.html">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.WithFieldNames(System.String[])"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.WithFieldNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.WithDeployed(System.Boolean)"> <summary> Sets the Deployed property </summary> <param name="deployed">The value to set for the Deployed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.DomainName"> <summary> The name of the domain you want to describe. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.FieldNames"> <summary> A list of the index fields you want to describe. If not specified, information is returned for all configured index fields. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.Deployed"> <summary> Whether to display the deployed configuration (<c>true</c>) or include any pending changes (<c>false</c>). Defaults to <c>false</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeIndexFieldsResponse"> <summary> Returns information about the DescribeIndexFieldsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsResponse.DescribeIndexFieldsResult"> <summary> Gets and sets the DescribeIndexFieldsResult property. The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeIndexFieldsResult"> <summary> <para>The result of a <c>DescribeIndexFields</c> request. Contains the index fields configured for the domain specified in the request.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeIndexFieldsResult.WithIndexFields(Amazon.CloudSearch.Model.IndexFieldStatus[])"> <summary> Adds elements to the IndexFields collection </summary> <param name="indexFields">The values to add to the IndexFields collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeIndexFieldsResult.WithIndexFields(System.Collections.Generic.IEnumerable{Amazon.CloudSearch.Model.IndexFieldStatus})"> <summary> Adds elements to the IndexFields collection </summary> <param name="indexFields">The values to add to the IndexFields collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsResult.IndexFields"> <summary> The index fields configured for the domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeScalingParametersRequest"> <summary> Container for the parameters to the DescribeScalingParameters operation. <para>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">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeScalingParametersRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeScalingParametersRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeScalingParametersResponse"> <summary> Returns information about the DescribeScalingParametersResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeScalingParametersResponse.DescribeScalingParametersResult"> <summary> Gets and sets the DescribeScalingParametersResult property. The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeScalingParametersResult"> <summary> <para>The result of a <c>DescribeScalingParameters</c> request. Contains the scaling parameters configured for the domain specified in the request.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeScalingParametersResult.WithScalingParameters(Amazon.CloudSearch.Model.ScalingParametersStatus)"> <summary> Sets the ScalingParameters property </summary> <param name="scalingParameters">The value to set for the ScalingParameters property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeScalingParametersResult.ScalingParameters"> <summary> The status and configuration of a search domain's scaling parameters. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest"> <summary> Container for the parameters to the DescribeServiceAccessPolicies operation. <para>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 <c>Deployed</c> option to <c>true</c> 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">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest.WithDeployed(System.Boolean)"> <summary> Sets the Deployed property </summary> <param name="deployed">The value to set for the Deployed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest.DomainName"> <summary> The name of the domain you want to describe. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest.Deployed"> <summary> Whether to display the deployed configuration (<c>true</c>) or include any pending changes (<c>false</c>). Defaults to <c>false</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResponse"> <summary> Returns information about the DescribeServiceAccessPoliciesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResponse.DescribeServiceAccessPoliciesResult"> <summary> Gets and sets the DescribeServiceAccessPoliciesResult property. The result of a DescribeServiceAccessPolicies request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResult"> <summary> <para>The result of a <c>DescribeServiceAccessPolicies</c> request.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResult.WithAccessPolicies(Amazon.CloudSearch.Model.AccessPoliciesStatus)"> <summary> Sets the AccessPolicies property </summary> <param name="accessPolicies">The value to set for the AccessPolicies property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResult.AccessPolicies"> <summary> The access rules configured for the domain specified in the request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeSuggestersRequest"> <summary> Container for the parameters to the DescribeSuggesters operation. <para>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 <c>Deployed</c> option to <c>true</c> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-search-suggestions.html">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.DescribeSuggestersRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeSuggestersRequest.WithSuggesterNames(System.String[])"> <summary> Adds elements to the SuggesterNames collection </summary> <param name="suggesterNames">The values to add to the SuggesterNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeSuggestersRequest.WithSuggesterNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SuggesterNames collection </summary> <param name="suggesterNames">The values to add to the SuggesterNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeSuggestersRequest.WithDeployed(System.Boolean)"> <summary> Sets the Deployed property </summary> <param name="deployed">The value to set for the Deployed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersRequest.DomainName"> <summary> The name of the domain you want to describe. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersRequest.SuggesterNames"> <summary> The suggesters you want to describe. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersRequest.Deployed"> <summary> Whether to display the deployed configuration (<c>true</c>) or include any pending changes (<c>false</c>). Defaults to <c>false</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeSuggestersResponse"> <summary> Returns information about the DescribeSuggestersResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersResponse.DescribeSuggestersResult"> <summary> Gets and sets the DescribeSuggestersResult property. The result of a DescribeSuggesters request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeSuggestersResult"> <summary> <para>The result of a <c>DescribeSuggesters</c> request.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DescribeSuggestersResult.WithSuggesters(Amazon.CloudSearch.Model.SuggesterStatus[])"> <summary> Adds elements to the Suggesters collection </summary> <param name="suggesters">The values to add to the Suggesters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DescribeSuggestersResult.WithSuggesters(System.Collections.Generic.IEnumerable{Amazon.CloudSearch.Model.SuggesterStatus})"> <summary> Adds elements to the Suggesters collection </summary> <param name="suggesters">The values to add to the Suggesters collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersResult.Suggesters"> <summary> The suggesters configured for the domain specified in the request. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DisabledOperationException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch.Model.DisabledOperationException.#ctor(System.String)"> <summary> Constructs a new DisabledOperationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch.Model.DocumentSuggesterOptions"> <summary> <para>Options for a search suggester.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DocumentSuggesterOptions.WithSourceField(System.String)"> <summary> Sets the SourceField property </summary> <param name="sourceField">The value to set for the SourceField property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DocumentSuggesterOptions.WithFuzzyMatching(System.String)"> <summary> Sets the FuzzyMatching property </summary> <param name="fuzzyMatching">The value to set for the FuzzyMatching property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DocumentSuggesterOptions.WithSortExpression(System.String)"> <summary> Sets the SortExpression property </summary> <param name="sortExpression">The value to set for the SortExpression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DocumentSuggesterOptions.SourceField"> <summary> The name of the index field you want to use for suggestions. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DocumentSuggesterOptions.FuzzyMatching"> <summary> The level of fuzziness allowed when suggesting matches for a string: <c>none</c>, <c>low</c>, or <c>high</c>. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>none, low, high</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DocumentSuggesterOptions.SortExpression"> <summary> An expression that computes a score for each suggestion to control how they are sorted. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DomainStatus"> <summary> <para>The current status of the search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithDomainId(System.String)"> <summary> Sets the DomainId property </summary> <param name="domainId">The value to set for the DomainId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithARN(System.String)"> <summary> Sets the ARN property </summary> <param name="aRN">The value to set for the ARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithCreated(System.Boolean)"> <summary> Sets the Created property </summary> <param name="created">The value to set for the Created property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithDeleted(System.Boolean)"> <summary> Sets the Deleted property </summary> <param name="deleted">The value to set for the Deleted property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithDocService(Amazon.CloudSearch.Model.ServiceEndpoint)"> <summary> Sets the DocService property </summary> <param name="docService">The value to set for the DocService property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithSearchService(Amazon.CloudSearch.Model.ServiceEndpoint)"> <summary> Sets the SearchService property </summary> <param name="searchService">The value to set for the SearchService property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithRequiresIndexDocuments(System.Boolean)"> <summary> Sets the RequiresIndexDocuments property </summary> <param name="requiresIndexDocuments">The value to set for the RequiresIndexDocuments property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithProcessing(System.Boolean)"> <summary> Sets the Processing property </summary> <param name="processing">The value to set for the Processing property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithSearchInstanceType(System.String)"> <summary> Sets the SearchInstanceType property </summary> <param name="searchInstanceType">The value to set for the SearchInstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithSearchPartitionCount(System.Int32)"> <summary> Sets the SearchPartitionCount property </summary> <param name="searchPartitionCount">The value to set for the SearchPartitionCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DomainStatus.WithSearchInstanceCount(System.Int32)"> <summary> Sets the SearchInstanceCount property </summary> <param name="searchInstanceCount">The value to set for the SearchInstanceCount property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.DomainId"> <summary> An internally generated unique identifier for a domain. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.ARN"> <summary> The Amazon Resource Name (ARN) of the search domain. See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.Created"> <summary> True if the search domain is created. It can take several minutes to initialize a domain when <a>CreateDomain</a> is called. Newly created search domains are returned from <a>DescribeDomains</a> with a false value for Created until domain creation is complete. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.Deleted"> <summary> True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when <a>DeleteDomain</a> is called. Newly deleted search domains are returned from <a>DescribeDomains</a> with a true value for IsDeleted for several minutes until resource cleanup is complete. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.DocService"> <summary> The service endpoint for updating documents in a search domain. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchService"> <summary> The service endpoint for requesting search results from a search domain. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.RequiresIndexDocuments"> <summary> True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.Processing"> <summary> True if processing is being done to activate the current domain configuration. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchInstanceType"> <summary> The instance type that is being used to process search requests. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchPartitionCount"> <summary> The number of partitions across which the search index is spread. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchInstanceCount"> <summary> The number of search instances that are available to process search requests. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DoubleArrayOptions"> <summary> <para>Options for a field that contains an array of double-precision 64-bit floating point values. Present if <c>IndexFieldType</c> specifies the field is of type <c>double-array</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DoubleArrayOptions.WithDefaultValue(System.Double)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleArrayOptions.WithSourceFields(System.String)"> <summary> Sets the SourceFields property </summary> <param name="sourceFields">The value to set for the SourceFields property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleArrayOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleArrayOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleArrayOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.SourceFields"> <summary> A list of source fields to map to the field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>\s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DoubleOptions"> <summary> <para>Options for a double-precision 64-bit floating point field. Present if <c>IndexFieldType</c> specifies the field is of type <c>double</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.DoubleOptions.WithDefaultValue(System.Double)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleOptions.WithSourceField(System.String)"> <summary> Sets the SourceField property </summary> <param name="sourceField">The value to set for the SourceField property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.DoubleOptions.WithSortEnabled(System.Boolean)"> <summary> Sets the SortEnabled property </summary> <param name="sortEnabled">The value to set for the SortEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.SourceField"> <summary> The name of the source field to map to the field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.SortEnabled"> <summary> Whether the field can be used to sort the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.Expression"> <summary> <para>A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions. </para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.Expression.WithExpressionName(System.String)"> <summary> Sets the ExpressionName property </summary> <param name="expressionName">The value to set for the ExpressionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.Expression.WithExpressionValue(System.String)"> <summary> Sets the ExpressionValue property </summary> <param name="expressionValue">The value to set for the ExpressionValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.Expression.ExpressionName"> <summary> A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <c>_id</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.Expression.ExpressionValue"> <summary> The expression to evaluate for sorting while processing a search request. The <c>Expression</c> syntax is based on JavaScript expressions. 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>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 10240</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.ExpressionStatus"> <summary> <para>The value of an <c>Expression</c> and its current status.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.ExpressionStatus.WithOptions(Amazon.CloudSearch.Model.Expression)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.ExpressionStatus.WithStatus(Amazon.CloudSearch.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.ExpressionStatus.Options"> <summary> The expression that is evaluated for sorting or filtering while processing a search request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ExpressionStatus.Status"> <summary> The status of domain configuration option. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexDocumentsRequest"> <summary> Container for the parameters to the IndexDocuments operation. <para>Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is <c>RequiresIndexDocuments</c> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.IndexDocumentsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.IndexDocumentsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexDocumentsResponse"> <summary> Returns information about the IndexDocumentsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexDocumentsResponse.IndexDocumentsResult"> <summary> Gets and sets the IndexDocumentsResult property. The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexDocumentsResult"> <summary> <para>The result of an <c>IndexDocuments</c> request. Contains the status of the indexing operation, including the fields being indexed.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.IndexDocumentsResult.WithFieldNames(System.String[])"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexDocumentsResult.WithFieldNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.IndexDocumentsResult.FieldNames"> <summary> The names of the fields that are currently being indexed. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexField"> <summary> <para>Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <c> IndexFieldType </c> .</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithIndexFieldName(System.String)"> <summary> Sets the IndexFieldName property </summary> <param name="indexFieldName">The value to set for the IndexFieldName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithIndexFieldType(System.String)"> <summary> Sets the IndexFieldType property </summary> <param name="indexFieldType">The value to set for the IndexFieldType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithIntOptions(Amazon.CloudSearch.Model.IntOptions)"> <summary> Sets the IntOptions property </summary> <param name="intOptions">The value to set for the IntOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithDoubleOptions(Amazon.CloudSearch.Model.DoubleOptions)"> <summary> Sets the DoubleOptions property </summary> <param name="doubleOptions">The value to set for the DoubleOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithLiteralOptions(Amazon.CloudSearch.Model.LiteralOptions)"> <summary> Sets the LiteralOptions property </summary> <param name="literalOptions">The value to set for the LiteralOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithTextOptions(Amazon.CloudSearch.Model.TextOptions)"> <summary> Sets the TextOptions property </summary> <param name="textOptions">The value to set for the TextOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithDateOptions(Amazon.CloudSearch.Model.DateOptions)"> <summary> Sets the DateOptions property </summary> <param name="dateOptions">The value to set for the DateOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithLatLonOptions(Amazon.CloudSearch.Model.LatLonOptions)"> <summary> Sets the LatLonOptions property </summary> <param name="latLonOptions">The value to set for the LatLonOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithIntArrayOptions(Amazon.CloudSearch.Model.IntArrayOptions)"> <summary> Sets the IntArrayOptions property </summary> <param name="intArrayOptions">The value to set for the IntArrayOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithDoubleArrayOptions(Amazon.CloudSearch.Model.DoubleArrayOptions)"> <summary> Sets the DoubleArrayOptions property </summary> <param name="doubleArrayOptions">The value to set for the DoubleArrayOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithLiteralArrayOptions(Amazon.CloudSearch.Model.LiteralArrayOptions)"> <summary> Sets the LiteralArrayOptions property </summary> <param name="literalArrayOptions">The value to set for the LiteralArrayOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithTextArrayOptions(Amazon.CloudSearch.Model.TextArrayOptions)"> <summary> Sets the TextArrayOptions property </summary> <param name="textArrayOptions">The value to set for the TextArrayOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexField.WithDateArrayOptions(Amazon.CloudSearch.Model.DateArrayOptions)"> <summary> Sets the DateArrayOptions property </summary> <param name="dateArrayOptions">The value to set for the DateArrayOptions property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IndexFieldName"> <summary> The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IndexFieldType"> <summary> The type of field. The valid options for a field depend on the field type. For more information about the supported field types, 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>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IntOptions"> <summary> Options for a 64-bit signed integer field. Present if <c>IndexFieldType</c> specifies the field is of type <c>int</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DoubleOptions"> <summary> Options for a double-precision 64-bit floating point field. Present if <c>IndexFieldType</c> specifies the field is of type <c>double</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.LiteralOptions"> <summary> Options for literal field. Present if <c>IndexFieldType</c> specifies the field is of type <c>literal</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.TextOptions"> <summary> Options for text field. Present if <c>IndexFieldType</c> specifies the field is of type <c>text</c>. A <c>text</c> field is always searchable. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DateOptions"> <summary> Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if <c>IndexFieldType</c> specifies the field is of type <c>date</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.LatLonOptions"> <summary> Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <c>IndexFieldType</c> specifies the field is of type <c>latlon</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IntArrayOptions"> <summary> Options for a field that contains an array of 64-bit signed integers. Present if <c>IndexFieldType</c> specifies the field is of type <c>int-array</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DoubleArrayOptions"> <summary> Options for a field that contains an array of double-precision 64-bit floating point values. Present if <c>IndexFieldType</c> specifies the field is of type <c>double-array</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.LiteralArrayOptions"> <summary> Options for a field that contains an array of literal strings. Present if <c>IndexFieldType</c> specifies the field is of type <c>literal-array</c>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.TextArrayOptions"> <summary> Options for a field that contains an array of text strings. Present if <c>IndexFieldType</c> specifies the field is of type <c>text-array</c>. A <c>text-array</c> field is always searchable. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DateArrayOptions"> <summary> Options for a field that contains an array of dates. Present if <c>IndexFieldType</c> specifies the field is of type <c>date-array</c>. All options are enabled by default. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexFieldStatus"> <summary> <para>The value of an <c>IndexField</c> and its current status.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.IndexFieldStatus.WithOptions(Amazon.CloudSearch.Model.IndexField)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IndexFieldStatus.WithStatus(Amazon.CloudSearch.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.IndexFieldStatus.Options"> <summary> Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <c><a>IndexFieldType</a></c>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexFieldStatus.Status"> <summary> The status of domain configuration option. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IntArrayOptions"> <summary> <para>Options for a field that contains an array of 64-bit signed integers. Present if <c>IndexFieldType</c> specifies the field is of type <c>int-array</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.IntArrayOptions.WithDefaultValue(System.Int64)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntArrayOptions.WithSourceFields(System.String)"> <summary> Sets the SourceFields property </summary> <param name="sourceFields">The value to set for the SourceFields property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntArrayOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntArrayOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntArrayOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.SourceFields"> <summary> A list of source fields to map to the field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>\s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.InternalException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch.Model.InternalException.#ctor(System.String)"> <summary> Constructs a new InternalException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AccessPoliciesStatusUnmarshaller"> <summary> AccessPoliciesStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AnalysisOptionsUnmarshaller"> <summary> AnalysisOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AnalysisSchemeStatusUnmarshaller"> <summary> AnalysisSchemeStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AnalysisSchemeUnmarshaller"> <summary> AnalysisScheme Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AvailabilityOptionsStatusUnmarshaller"> <summary> AvailabilityOptionsStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.BuildSuggestersRequestMarshaller"> <summary> Build Suggesters Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.BuildSuggestersResponseUnmarshaller"> <summary> Response Unmarshaller for BuildSuggesters operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.BuildSuggestersResultUnmarshaller"> <summary> BuildSuggestersResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.CreateDomainRequestMarshaller"> <summary> Create Domain Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.CreateDomainResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDomain operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.CreateDomainResultUnmarshaller"> <summary> CreateDomainResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DateArrayOptionsUnmarshaller"> <summary> DateArrayOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DateOptionsUnmarshaller"> <summary> DateOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineAnalysisSchemeRequestMarshaller"> <summary> Define Analysis Scheme Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineAnalysisSchemeResponseUnmarshaller"> <summary> Response Unmarshaller for DefineAnalysisScheme operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineAnalysisSchemeResultUnmarshaller"> <summary> DefineAnalysisSchemeResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineExpressionRequestMarshaller"> <summary> Define Expression Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineExpressionResponseUnmarshaller"> <summary> Response Unmarshaller for DefineExpression operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineExpressionResultUnmarshaller"> <summary> DefineExpressionResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineIndexFieldRequestMarshaller"> <summary> Define Index Field Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineIndexFieldResponseUnmarshaller"> <summary> Response Unmarshaller for DefineIndexField operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineIndexFieldResultUnmarshaller"> <summary> DefineIndexFieldResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineSuggesterRequestMarshaller"> <summary> Define Suggester Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineSuggesterResponseUnmarshaller"> <summary> Response Unmarshaller for DefineSuggester operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineSuggesterResultUnmarshaller"> <summary> DefineSuggesterResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteAnalysisSchemeRequestMarshaller"> <summary> Delete Analysis Scheme Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteAnalysisSchemeResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteAnalysisScheme operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteAnalysisSchemeResultUnmarshaller"> <summary> DeleteAnalysisSchemeResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteDomainRequestMarshaller"> <summary> Delete Domain Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteDomainResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDomain operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteDomainResultUnmarshaller"> <summary> DeleteDomainResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteExpressionRequestMarshaller"> <summary> Delete Expression Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteExpressionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteExpression operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteExpressionResultUnmarshaller"> <summary> DeleteExpressionResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteIndexFieldRequestMarshaller"> <summary> Delete Index Field Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteIndexFieldResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteIndexField operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteIndexFieldResultUnmarshaller"> <summary> DeleteIndexFieldResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteSuggesterRequestMarshaller"> <summary> Delete Suggester Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteSuggesterResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSuggester operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DeleteSuggesterResultUnmarshaller"> <summary> DeleteSuggesterResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeAnalysisSchemesRequestMarshaller"> <summary> Describe Analysis Schemes Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeAnalysisSchemesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAnalysisSchemes operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeAnalysisSchemesResultUnmarshaller"> <summary> DescribeAnalysisSchemesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeAvailabilityOptionsRequestMarshaller"> <summary> Describe Availability Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeAvailabilityOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAvailabilityOptions operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeAvailabilityOptionsResultUnmarshaller"> <summary> DescribeAvailabilityOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeDomainsRequestMarshaller"> <summary> Describe Domains Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeDomainsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDomains operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeDomainsResultUnmarshaller"> <summary> DescribeDomainsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeExpressionsRequestMarshaller"> <summary> Describe Expressions Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeExpressionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeExpressions operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeExpressionsResultUnmarshaller"> <summary> DescribeExpressionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeIndexFieldsRequestMarshaller"> <summary> Describe Index Fields Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeIndexFieldsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeIndexFields operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeIndexFieldsResultUnmarshaller"> <summary> DescribeIndexFieldsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeScalingParametersRequestMarshaller"> <summary> Describe Scaling Parameters Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeScalingParametersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeScalingParameters operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeScalingParametersResultUnmarshaller"> <summary> DescribeScalingParametersResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeServiceAccessPoliciesRequestMarshaller"> <summary> Describe Service Access Policies Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeServiceAccessPoliciesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeServiceAccessPolicies operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeServiceAccessPoliciesResultUnmarshaller"> <summary> DescribeServiceAccessPoliciesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeSuggestersRequestMarshaller"> <summary> Describe Suggesters Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeSuggestersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSuggesters operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DescribeSuggestersResultUnmarshaller"> <summary> DescribeSuggestersResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DocumentSuggesterOptionsUnmarshaller"> <summary> DocumentSuggesterOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DomainStatusUnmarshaller"> <summary> DomainStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DoubleArrayOptionsUnmarshaller"> <summary> DoubleArrayOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DoubleOptionsUnmarshaller"> <summary> DoubleOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ExpressionStatusUnmarshaller"> <summary> ExpressionStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ExpressionUnmarshaller"> <summary> Expression Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IndexDocumentsRequestMarshaller"> <summary> Index Documents Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IndexDocumentsResponseUnmarshaller"> <summary> Response Unmarshaller for IndexDocuments operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IndexDocumentsResultUnmarshaller"> <summary> IndexDocumentsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IndexFieldStatusUnmarshaller"> <summary> IndexFieldStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IndexFieldUnmarshaller"> <summary> IndexField Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IntArrayOptionsUnmarshaller"> <summary> IntArrayOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IntOptionsUnmarshaller"> <summary> IntOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.LatLonOptionsUnmarshaller"> <summary> LatLonOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ListDomainNamesRequestMarshaller"> <summary> List Domain Names Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ListDomainNamesResponseUnmarshaller"> <summary> Response Unmarshaller for ListDomainNames operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ListDomainNamesResultUnmarshaller"> <summary> ListDomainNamesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.LiteralArrayOptionsUnmarshaller"> <summary> LiteralArrayOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.LiteralOptionsUnmarshaller"> <summary> LiteralOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.OptionStatusUnmarshaller"> <summary> OptionStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ScalingParametersStatusUnmarshaller"> <summary> ScalingParametersStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ScalingParametersUnmarshaller"> <summary> ScalingParameters Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ServiceEndpointUnmarshaller"> <summary> ServiceEndpoint Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.SuggesterStatusUnmarshaller"> <summary> SuggesterStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.SuggesterUnmarshaller"> <summary> Suggester Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.TextArrayOptionsUnmarshaller"> <summary> TextArrayOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.TextOptionsUnmarshaller"> <summary> TextOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateAvailabilityOptionsRequestMarshaller"> <summary> Update Availability Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateAvailabilityOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateAvailabilityOptions operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateAvailabilityOptionsResultUnmarshaller"> <summary> UpdateAvailabilityOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateScalingParametersRequestMarshaller"> <summary> Update Scaling Parameters Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateScalingParametersResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateScalingParameters operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateScalingParametersResultUnmarshaller"> <summary> UpdateScalingParametersResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateServiceAccessPoliciesRequestMarshaller"> <summary> Update Service Access Policies Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateServiceAccessPoliciesResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateServiceAccessPolicies operation </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateServiceAccessPoliciesResultUnmarshaller"> <summary> UpdateServiceAccessPoliciesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch.Model.IntOptions"> <summary> <para>Options for a 64-bit signed integer field. Present if <c>IndexFieldType</c> specifies the field is of type <c>int</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.IntOptions.WithDefaultValue(System.Int64)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntOptions.WithSourceField(System.String)"> <summary> Sets the SourceField property </summary> <param name="sourceField">The value to set for the SourceField property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.IntOptions.WithSortEnabled(System.Boolean)"> <summary> Sets the SortEnabled property </summary> <param name="sortEnabled">The value to set for the SortEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.SourceField"> <summary> The name of the source field to map to the field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.SortEnabled"> <summary> Whether the field can be used to sort the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.InvalidTypeException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch.Model.InvalidTypeException.#ctor(System.String)"> <summary> Constructs a new InvalidTypeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch.Model.LatLonOptions"> <summary> <para>Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <c>IndexFieldType</c> specifies the field is of type <c>latlon</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.LatLonOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LatLonOptions.WithSourceField(System.String)"> <summary> Sets the SourceField property </summary> <param name="sourceField">The value to set for the SourceField property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LatLonOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LatLonOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LatLonOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LatLonOptions.WithSortEnabled(System.Boolean)"> <summary> Sets the SortEnabled property </summary> <param name="sortEnabled">The value to set for the SortEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.SourceField"> <summary> A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <c>_id</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.SortEnabled"> <summary> Whether the field can be used to sort the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.LimitExceededException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch.Model.ListDomainNamesRequest"> <summary> Container for the parameters to the ListDomainNames operation. <para>Lists all search domains owned by an account.</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"/> </member> <member name="T:Amazon.CloudSearch.Model.ListDomainNamesResponse"> <summary> Returns information about the ListDomainNamesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ListDomainNamesResponse.ListDomainNamesResult"> <summary> Gets and sets the ListDomainNamesResult property. The result of a ListDomainNames request. Contains a list of the domains owned by an account. </summary> </member> <member name="T:Amazon.CloudSearch.Model.ListDomainNamesResult"> <summary> <para>The result of a <c>ListDomainNames</c> request. Contains a list of the domains owned by an account.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.ListDomainNamesResult.WithDomainNames(System.Collections.Generic.KeyValuePair{System.String,System.String}[])"> <summary> Adds the KeyValuePairs to the DomainNames dictionary. </summary> <param name="pairs">The pairs to be added to the DomainNames dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.ListDomainNamesResult.DomainNames"> <summary> The names of the search domains owned by an account. </summary> </member> <member name="T:Amazon.CloudSearch.Model.LiteralArrayOptions"> <summary> <para>Options for a field that contains an array of literal strings. Present if <c>IndexFieldType</c> specifies the field is of type <c>literal-array</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.LiteralArrayOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralArrayOptions.WithSourceFields(System.String)"> <summary> Sets the SourceFields property </summary> <param name="sourceFields">The value to set for the SourceFields property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralArrayOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralArrayOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralArrayOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.SourceFields"> <summary> A list of source fields to map to the field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>\s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.LiteralOptions"> <summary> <para>Options for literal field. Present if <c>IndexFieldType</c> specifies the field is of type <c>literal</c> . All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.LiteralOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralOptions.WithSourceField(System.String)"> <summary> Sets the SourceField property </summary> <param name="sourceField">The value to set for the SourceField property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.LiteralOptions.WithSortEnabled(System.Boolean)"> <summary> Sets the SortEnabled property </summary> <param name="sortEnabled">The value to set for the SortEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.SourceField"> <summary> A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <c>_id</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.FacetEnabled"> <summary> Whether facet information can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.SearchEnabled"> <summary> Whether the contents of the field are searchable. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.SortEnabled"> <summary> Whether the field can be used to sort the search results. </summary> </member> <member name="T:Amazon.CloudSearch.Model.OptionStatus"> <summary> <para>The status of domain configuration option.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.OptionStatus.WithCreationDate(System.DateTime)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.OptionStatus.WithUpdateDate(System.DateTime)"> <summary> Sets the UpdateDate property </summary> <param name="updateDate">The value to set for the UpdateDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.OptionStatus.WithUpdateVersion(System.Int32)"> <summary> Sets the UpdateVersion property </summary> <param name="updateVersion">The value to set for the UpdateVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.OptionStatus.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.OptionStatus.WithPendingDeletion(System.Boolean)"> <summary> Sets the PendingDeletion property </summary> <param name="pendingDeletion">The value to set for the PendingDeletion property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.CreationDate"> <summary> A timestamp for when this option was created. </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.UpdateDate"> <summary> A timestamp for when this option was last updated. </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.UpdateVersion"> <summary> A unique integer that indicates when this option was last updated. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>0 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.State"> <summary> The state of processing a change to an option. Possible values:<ul> <li><c>RequiresIndexDocuments</c>: the option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li> <li><c>Processing</c>: the option's latest value is in the process of being activated. </li> <li><c>Active</c>: the option's latest value is completely deployed.</li> <li><c>FailedToValidate</c>: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>RequiresIndexDocuments, Processing, Active, FailedToValidate</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.PendingDeletion"> <summary> Indicates that the option will be deleted once processing is complete. </summary> </member> <member name="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch.Model.ResourceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ResourceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch.Model.ScalingParameters"> <summary> <para>The desired instance type and desired number of replicas of each index partition.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.ScalingParameters.WithDesiredInstanceType(System.String)"> <summary> Sets the DesiredInstanceType property </summary> <param name="desiredInstanceType">The value to set for the DesiredInstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.ScalingParameters.WithDesiredReplicationCount(System.Int32)"> <summary> Sets the DesiredReplicationCount property </summary> <param name="desiredReplicationCount">The value to set for the DesiredReplicationCount property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParameters.DesiredInstanceType"> <summary> The instance type that you want to preconfigure for your domain. For example, <c>search.m1.small</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParameters.DesiredReplicationCount"> <summary> The number of replicas you want to preconfigure for each index partition. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>0 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.ScalingParametersStatus"> <summary> <para>The status and configuration of a search domain's scaling parameters. </para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.ScalingParametersStatus.WithOptions(Amazon.CloudSearch.Model.ScalingParameters)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.ScalingParametersStatus.WithStatus(Amazon.CloudSearch.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParametersStatus.Options"> <summary> The desired instance type and desired number of replicas of each index partition. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParametersStatus.Status"> <summary> The status of domain configuration option. </summary> </member> <member name="T:Amazon.CloudSearch.Model.ServiceEndpoint"> <summary> <para>The endpoint to which service requests can be submitted, including the actual URL prefix for sending requests and the Amazon Resource Name (ARN) so the endpoint can be referenced in other API calls such as UpdateServiceAccessPolicies.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.ServiceEndpoint.WithEndpoint(System.String)"> <summary> Sets the Endpoint property </summary> <param name="endpoint">The value to set for the Endpoint property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.ServiceEndpoint.Endpoint"> <summary> The URL to which service requests can be submitted. Includes the API version and path prefix. For example, <c>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com/2013-01-01/search</c> or <c>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com/2013-01-01/documents/batch</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.Suggester"> <summary> <para>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <c>FuzzyMatching</c> , <c>SortExpression</c> . </para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.Suggester.WithSuggesterName(System.String)"> <summary> Sets the SuggesterName property </summary> <param name="suggesterName">The value to set for the SuggesterName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.Suggester.WithDocumentSuggesterOptions(Amazon.CloudSearch.Model.DocumentSuggesterOptions)"> <summary> Sets the DocumentSuggesterOptions property </summary> <param name="documentSuggesterOptions">The value to set for the DocumentSuggesterOptions property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.Suggester.SuggesterName"> <summary> A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <c>_id</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.Suggester.DocumentSuggesterOptions"> <summary> Options for a search suggester. </summary> </member> <member name="T:Amazon.CloudSearch.Model.SuggesterStatus"> <summary> <para>The value of a <c>Suggester</c> and its current status.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.SuggesterStatus.WithOptions(Amazon.CloudSearch.Model.Suggester)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.SuggesterStatus.WithStatus(Amazon.CloudSearch.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.SuggesterStatus.Options"> <summary> Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <c>FuzzyMatching</c>, <c>SortExpression</c>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.SuggesterStatus.Status"> <summary> The status of domain configuration option. </summary> </member> <member name="T:Amazon.CloudSearch.Model.TextArrayOptions"> <summary> <para>Options for a field that contains an array of text strings. Present if <c>IndexFieldType</c> specifies the field is of type <c>text-array</c> . A <c>text-array</c> field is always searchable. All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.TextArrayOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextArrayOptions.WithSourceFields(System.String)"> <summary> Sets the SourceFields property </summary> <param name="sourceFields">The value to set for the SourceFields property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextArrayOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextArrayOptions.WithHighlightEnabled(System.Boolean)"> <summary> Sets the HighlightEnabled property </summary> <param name="highlightEnabled">The value to set for the HighlightEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextArrayOptions.WithAnalysisScheme(System.String)"> <summary> Sets the AnalysisScheme property </summary> <param name="analysisScheme">The value to set for the AnalysisScheme property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.SourceFields"> <summary> A list of source fields to map to the field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>\s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.HighlightEnabled"> <summary> Whether highlights can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.AnalysisScheme"> <summary> The name of an analysis scheme for a <c>text-array</c> field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>[\S]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.TextOptions"> <summary> <para>Options for text field. Present if <c>IndexFieldType</c> specifies the field is of type <c>text</c> . A <c>text</c> field is always searchable. All options are enabled by default.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.TextOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextOptions.WithSourceField(System.String)"> <summary> Sets the SourceField property </summary> <param name="sourceField">The value to set for the SourceField property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextOptions.WithReturnEnabled(System.Boolean)"> <summary> Sets the ReturnEnabled property </summary> <param name="returnEnabled">The value to set for the ReturnEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextOptions.WithSortEnabled(System.Boolean)"> <summary> Sets the SortEnabled property </summary> <param name="sortEnabled">The value to set for the SortEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextOptions.WithHighlightEnabled(System.Boolean)"> <summary> Sets the HighlightEnabled property </summary> <param name="highlightEnabled">The value to set for the HighlightEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.TextOptions.WithAnalysisScheme(System.String)"> <summary> Sets the AnalysisScheme property </summary> <param name="analysisScheme">The value to set for the AnalysisScheme property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.DefaultValue"> <summary> A value to use for the field if the field isn't specified for a document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.SourceField"> <summary> A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <c>_id</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.ReturnEnabled"> <summary> Whether the contents of the field can be returned in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.SortEnabled"> <summary> Whether the field can be used to sort the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.HighlightEnabled"> <summary> Whether highlights can be returned for the field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.AnalysisScheme"> <summary> The name of an analysis scheme for a <c>text</c> field. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>[\S]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest"> <summary> Container for the parameters to the UpdateAvailabilityOptions operation. <para>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">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest.WithMultiAZ(System.Boolean)"> <summary> Sets the MultiAZ property </summary> <param name="multiAZ">The value to set for the MultiAZ property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest.MultiAZ"> <summary> You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to <c>false</c>. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResponse"> <summary> Returns information about the UpdateAvailabilityOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResponse.UpdateAvailabilityOptionsResult"> <summary> Gets and sets the UpdateAvailabilityOptionsResult property. The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResult"> <summary> <para>The result of a <c>UpdateAvailabilityOptions</c> request. Contains the status of the domain's availability options. </para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResult.WithAvailabilityOptions(Amazon.CloudSearch.Model.AvailabilityOptionsStatus)"> <summary> Sets the AvailabilityOptions property </summary> <param name="availabilityOptions">The value to set for the AvailabilityOptions property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResult.AvailabilityOptions"> <summary> The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateScalingParametersRequest"> <summary> Container for the parameters to the UpdateScalingParameters operation. <para>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">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i> . </para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.UpdateScalingParametersRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.UpdateScalingParametersRequest.WithScalingParameters(Amazon.CloudSearch.Model.ScalingParameters)"> <summary> Sets the ScalingParameters property </summary> <param name="scalingParameters">The value to set for the ScalingParameters property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersRequest.ScalingParameters"> <summary> The desired instance type and desired number of replicas of each index partition. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateScalingParametersResponse"> <summary> Returns information about the UpdateScalingParametersResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersResponse.UpdateScalingParametersResult"> <summary> Gets and sets the UpdateScalingParametersResult property. The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateScalingParametersResult"> <summary> <para>The result of a <c>UpdateScalingParameters</c> request. Contains the status of the newly-configured scaling parameters.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.UpdateScalingParametersResult.WithScalingParameters(Amazon.CloudSearch.Model.ScalingParametersStatus)"> <summary> Sets the ScalingParameters property </summary> <param name="scalingParameters">The value to set for the ScalingParameters property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersResult.ScalingParameters"> <summary> The status and configuration of a search domain's scaling parameters. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest"> <summary> Container for the parameters to the UpdateServiceAccessPolicies operation. <para>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"> Configuring Access for an Amazon CloudSearch Domain</a> .</para> </summary> <seealso cref="M:Amazon.CloudSearch.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"/> </member> <member name="M:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest.WithAccessPolicies(System.String)"> <summary> Sets the AccessPolicies property </summary> <param name="accessPolicies">The value to set for the AccessPolicies property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest.AccessPolicies"> <summary> The access rules you want to configure. These rules replace any existing rules. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResponse"> <summary> Returns information about the UpdateServiceAccessPoliciesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResponse.UpdateServiceAccessPoliciesResult"> <summary> Gets and sets the UpdateServiceAccessPoliciesResult property. The result of an UpdateServiceAccessPolicies request. Contains the new access policies. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResult"> <summary> <para>The result of an <c>UpdateServiceAccessPolicies</c> request. Contains the new access policies.</para> </summary> </member> <member name="M:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResult.WithAccessPolicies(Amazon.CloudSearch.Model.AccessPoliciesStatus)"> <summary> Sets the AccessPolicies property </summary> <param name="accessPolicies">The value to set for the AccessPolicies property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResult.AccessPolicies"> <summary> The access rules configured for the domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch"> <summary> Interface for accessing AmazonCloudSearch. 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.AmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"> <summary> <para>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. </para> </summary> <param name="updateDefaultSearchFieldRequest">Container for the necessary parameters to execute the UpdateDefaultSearchField service method on AmazonCloudSearch.</param> <returns>The response from the UpdateDefaultSearchField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginUpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"/> </summary> <param name="updateDefaultSearchFieldRequest">Container for the necessary parameters to execute the UpdateDefaultSearchField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDefaultSearchField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndUpdateDefaultSearchField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDefaultSearchField.</param> <returns>Returns a UpdateDefaultSearchFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"> <summary> <para>Removes a <c>RankExpression</c> from the search domain.</para> </summary> <param name="deleteRankExpressionRequest">Container for the necessary parameters to execute the DeleteRankExpression service method on AmazonCloudSearch.</param> <returns>The response from the DeleteRankExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"/> </summary> <param name="deleteRankExpressionRequest">Container for the necessary parameters to execute the DeleteRankExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRankExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDeleteRankExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRankExpression.</param> <returns>Returns a DeleteRankExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"> <summary> <para>Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </para> </summary> <param name="describeRankExpressionsRequest">Container for the necessary parameters to execute the DescribeRankExpressions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeRankExpressions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRankExpressions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"/> </summary> <param name="describeRankExpressionsRequest">Container for the necessary parameters to execute the DescribeRankExpressions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRankExpressions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeRankExpressions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeRankExpressions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRankExpressions.</param> <returns>Returns a DescribeRankExpressionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"> <summary> <para>Creates a new search domain.</para> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain service method on AmazonCloudSearch.</param> <returns>The response from the CreateDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginCreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"/> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndCreateDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"> <summary> <para>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.</para> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndUpdateServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"> <summary> <para>Configures an <c>IndexField</c> 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.</para> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DefineIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"/> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDefineIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"> <summary> <para>Configures a <c>RankExpression</c> 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.</para> </summary> <param name="defineRankExpressionRequest">Container for the necessary parameters to execute the DefineRankExpression service method on AmazonCloudSearch.</param> <returns>The response from the DefineRankExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"/> </summary> <param name="defineRankExpressionRequest">Container for the necessary parameters to execute the DefineRankExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineRankExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDefineRankExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineRankExpression.</param> <returns>Returns a DefineRankExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"> <summary> <para>Gets the synonym dictionary configured for the search domain.</para> </summary> <param name="describeSynonymOptionsRequest">Container for the necessary parameters to execute the DescribeSynonymOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeSynonymOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"/> </summary> <param name="describeSynonymOptionsRequest">Container for the necessary parameters to execute the DescribeSynonymOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSynonymOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeSynonymOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSynonymOptions.</param> <returns>Returns a DescribeSynonymOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"> <summary> <para>Gets the stopwords configured for the search domain.</para> </summary> <param name="describeStopwordOptionsRequest">Container for the necessary parameters to execute the DescribeStopwordOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeStopwordOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"/> </summary> <param name="describeStopwordOptionsRequest">Container for the necessary parameters to execute the DescribeStopwordOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStopwordOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeStopwordOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStopwordOptions.</param> <returns>Returns a DescribeStopwordOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"> <summary> <para>Permanently deletes a search domain and all of its data.</para> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain service method on AmazonCloudSearch.</param> <returns>The response from the DeleteDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"/> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDeleteDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"> <summary> <para>Gets information about the resource-based policies that control access to the domain's document and search services.</para> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"> <summary> <para>Gets the default search field configured for the search domain.</para> </summary> <param name="describeDefaultSearchFieldRequest">Container for the necessary parameters to execute the DescribeDefaultSearchField service method on AmazonCloudSearch.</param> <returns>The response from the DescribeDefaultSearchField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"/> </summary> <param name="describeDefaultSearchFieldRequest">Container for the necessary parameters to execute the DescribeDefaultSearchField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDefaultSearchField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeDefaultSearchField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDefaultSearchField.</param> <returns>Returns a DescribeDefaultSearchFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"> <summary> <para>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.</para> </summary> <param name="updateStopwordOptionsRequest">Container for the necessary parameters to execute the UpdateStopwordOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateStopwordOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginUpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"/> </summary> <param name="updateStopwordOptionsRequest">Container for the necessary parameters to execute the UpdateStopwordOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStopwordOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndUpdateStopwordOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStopwordOptions.</param> <returns>Returns a UpdateStopwordOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"> <summary> <para>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. </para> </summary> <param name="updateSynonymOptionsRequest">Container for the necessary parameters to execute the UpdateSynonymOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateSynonymOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginUpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"/> </summary> <param name="updateSynonymOptionsRequest">Container for the necessary parameters to execute the UpdateSynonymOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSynonymOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndUpdateSynonymOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSynonymOptions.</param> <returns>Returns a UpdateSynonymOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"> <summary> <para>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.</para> </summary> <param name="updateStemmingOptionsRequest">Container for the necessary parameters to execute the UpdateStemmingOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateStemmingOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginUpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"/> </summary> <param name="updateStemmingOptionsRequest">Container for the necessary parameters to execute the UpdateStemmingOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStemmingOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndUpdateStemmingOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStemmingOptions.</param> <returns>Returns a UpdateStemmingOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"> <summary> <para>Gets the stemming dictionary configured for the search domain.</para> </summary> <param name="describeStemmingOptionsRequest">Container for the necessary parameters to execute the DescribeStemmingOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeStemmingOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"/> </summary> <param name="describeStemmingOptionsRequest">Container for the necessary parameters to execute the DescribeStemmingOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStemmingOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeStemmingOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStemmingOptions.</param> <returns>Returns a DescribeStemmingOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.</para> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains service method on AmazonCloudSearch.</param> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"/> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDomains operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeDomains(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDomains"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.</para> </summary> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"> <summary> <para>Tells the search domain to start indexing its documents using the latest text processing options and <c>IndexFields</c> . This operation must be invoked to make options whose OptionStatus has <c>OptionState</c> of <c>RequiresIndexDocuments</c> visible in search results.</para> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments service method on AmazonCloudSearch.</param> <returns>The response from the IndexDocuments service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginIndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"/> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndIndexDocuments operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndIndexDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"> <summary> <para>Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.</para> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields service method on AmazonCloudSearch.</param> <returns>The response from the DescribeIndexFields service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIndexFields operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDescribeIndexFields(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"> <summary> <para>Removes an <c>IndexField</c> from the search domain.</para> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DeleteIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.BeginDeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"/> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.EndDeleteIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="T:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient"> <summary> Implementation for accessing AmazonCloudSearch. 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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearch 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"> <summary> <para>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. </para> </summary> <param name="updateDefaultSearchFieldRequest">Container for the necessary parameters to execute the UpdateDefaultSearchField service method on AmazonCloudSearch.</param> <returns>The response from the UpdateDefaultSearchField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"/> </summary> <param name="updateDefaultSearchFieldRequest">Container for the necessary parameters to execute the UpdateDefaultSearchField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDefaultSearchField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndUpdateDefaultSearchField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDefaultSearchField.</param> <returns>Returns a UpdateDefaultSearchFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"> <summary> <para>Removes a <c>RankExpression</c> from the search domain.</para> </summary> <param name="deleteRankExpressionRequest">Container for the necessary parameters to execute the DeleteRankExpression service method on AmazonCloudSearch.</param> <returns>The response from the DeleteRankExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"/> </summary> <param name="deleteRankExpressionRequest">Container for the necessary parameters to execute the DeleteRankExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRankExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDeleteRankExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRankExpression.</param> <returns>Returns a DeleteRankExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"> <summary> <para>Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </para> </summary> <param name="describeRankExpressionsRequest">Container for the necessary parameters to execute the DescribeRankExpressions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeRankExpressions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRankExpressions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"/> </summary> <param name="describeRankExpressionsRequest">Container for the necessary parameters to execute the DescribeRankExpressions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRankExpressions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeRankExpressions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeRankExpressions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRankExpressions.</param> <returns>Returns a DescribeRankExpressionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"> <summary> <para>Creates a new search domain.</para> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain service method on AmazonCloudSearch.</param> <returns>The response from the CreateDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginCreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"/> </summary> <param name="createDomainRequest">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndCreateDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"> <summary> <para>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.</para> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="updateServiceAccessPoliciesRequest">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndUpdateServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"> <summary> <para>Configures an <c>IndexField</c> 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.</para> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DefineIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"/> </summary> <param name="defineIndexFieldRequest">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDefineIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"> <summary> <para>Configures a <c>RankExpression</c> 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.</para> </summary> <param name="defineRankExpressionRequest">Container for the necessary parameters to execute the DefineRankExpression service method on AmazonCloudSearch.</param> <returns>The response from the DefineRankExpression service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"/> </summary> <param name="defineRankExpressionRequest">Container for the necessary parameters to execute the DefineRankExpression operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDefineRankExpression operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDefineRankExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineRankExpression operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineRankExpression.</param> <returns>Returns a DefineRankExpressionResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"> <summary> <para>Gets the synonym dictionary configured for the search domain.</para> </summary> <param name="describeSynonymOptionsRequest">Container for the necessary parameters to execute the DescribeSynonymOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeSynonymOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"/> </summary> <param name="describeSynonymOptionsRequest">Container for the necessary parameters to execute the DescribeSynonymOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSynonymOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeSynonymOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSynonymOptions.</param> <returns>Returns a DescribeSynonymOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"> <summary> <para>Gets the stopwords configured for the search domain.</para> </summary> <param name="describeStopwordOptionsRequest">Container for the necessary parameters to execute the DescribeStopwordOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeStopwordOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"/> </summary> <param name="describeStopwordOptionsRequest">Container for the necessary parameters to execute the DescribeStopwordOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStopwordOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeStopwordOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStopwordOptions.</param> <returns>Returns a DescribeStopwordOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"> <summary> <para>Permanently deletes a search domain and all of its data.</para> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain service method on AmazonCloudSearch.</param> <returns>The response from the DeleteDomain service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"/> </summary> <param name="deleteDomainRequest">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDomain operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDeleteDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDomain operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"> <summary> <para>Gets information about the resource-based policies that control access to the domain's document and search services.</para> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method on AmazonCloudSearch.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="describeServiceAccessPoliciesRequest">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeServiceAccessPolicies operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"> <summary> <para>Gets the default search field configured for the search domain.</para> </summary> <param name="describeDefaultSearchFieldRequest">Container for the necessary parameters to execute the DescribeDefaultSearchField service method on AmazonCloudSearch.</param> <returns>The response from the DescribeDefaultSearchField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"/> </summary> <param name="describeDefaultSearchFieldRequest">Container for the necessary parameters to execute the DescribeDefaultSearchField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDefaultSearchField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeDefaultSearchField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDefaultSearchField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDefaultSearchField.</param> <returns>Returns a DescribeDefaultSearchFieldResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"> <summary> <para>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.</para> </summary> <param name="updateStopwordOptionsRequest">Container for the necessary parameters to execute the UpdateStopwordOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateStopwordOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"/> </summary> <param name="updateStopwordOptionsRequest">Container for the necessary parameters to execute the UpdateStopwordOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStopwordOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndUpdateStopwordOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStopwordOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStopwordOptions.</param> <returns>Returns a UpdateStopwordOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"> <summary> <para>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. </para> </summary> <param name="updateSynonymOptionsRequest">Container for the necessary parameters to execute the UpdateSynonymOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateSynonymOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"/> </summary> <param name="updateSynonymOptionsRequest">Container for the necessary parameters to execute the UpdateSynonymOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSynonymOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndUpdateSynonymOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateSynonymOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSynonymOptions.</param> <returns>Returns a UpdateSynonymOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"> <summary> <para>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.</para> </summary> <param name="updateStemmingOptionsRequest">Container for the necessary parameters to execute the UpdateStemmingOptions service method on AmazonCloudSearch.</param> <returns>The response from the UpdateStemmingOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"/> </summary> <param name="updateStemmingOptionsRequest">Container for the necessary parameters to execute the UpdateStemmingOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStemmingOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndUpdateStemmingOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStemmingOptions.</param> <returns>Returns a UpdateStemmingOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"> <summary> <para>Gets the stemming dictionary configured for the search domain.</para> </summary> <param name="describeStemmingOptionsRequest">Container for the necessary parameters to execute the DescribeStemmingOptions service method on AmazonCloudSearch.</param> <returns>The response from the DescribeStemmingOptions service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"/> </summary> <param name="describeStemmingOptionsRequest">Container for the necessary parameters to execute the DescribeStemmingOptions operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStemmingOptions operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeStemmingOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStemmingOptions operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStemmingOptions.</param> <returns>Returns a DescribeStemmingOptionsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.</para> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains service method on AmazonCloudSearch.</param> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"/> </summary> <param name="describeDomainsRequest">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDomains operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeDomains(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDomains operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDomains"> <summary> <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.</para> </summary> <returns>The response from the DescribeDomains service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"> <summary> <para>Tells the search domain to start indexing its documents using the latest text processing options and <c>IndexFields</c> . This operation must be invoked to make options whose OptionStatus has <c>OptionState</c> of <c>RequiresIndexDocuments</c> visible in search results.</para> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments service method on AmazonCloudSearch.</param> <returns>The response from the IndexDocuments service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginIndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"/> </summary> <param name="indexDocumentsRequest">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndIndexDocuments operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndIndexDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the IndexDocuments operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"> <summary> <para>Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.</para> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields service method on AmazonCloudSearch.</param> <returns>The response from the DescribeIndexFields service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="describeIndexFieldsRequest">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIndexFields operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDescribeIndexFields(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIndexFields operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from AmazonCloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"> <summary> <para>Removes an <c>IndexField</c> from the search domain.</para> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField service method on AmazonCloudSearch.</param> <returns>The response from the DeleteIndexField service method, as returned by AmazonCloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"/> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"/> </summary> <param name="deleteIndexFieldRequest">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIndexField operation.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.EndDeleteIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIndexField operation. <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from AmazonCloudSearch.</returns> </member> <member name="T:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig"> <summary> Configuration for accessing Amazon CloudSearch Configuration Service service </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig.UserAgent"> <summary> Gets and sets of the UserAgent property. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus"> <summary> <para>A <c>PolicyDocument</c> that specifies access policies for the search domain's services, and the current status of those policies.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus.WithOptions(System.String)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus.WithStatus(Amazon.CloudSearch_2011_02_01.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus.Options"> <summary> An IAM access policy as described in <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?AccessPolicyLanguage.html" target="_blank">The Access Policy Language</a> in <i>Using AWS Identity and Access Management</i>. The maximum size of an access policy document is 100 KB. Example: <c>{"Statement": [{"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }}, {"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }</c> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus.Status"> <summary> The status of an option, including when it was last updated and whether it is actively in use for searches. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.BaseException.#ctor(System.String)"> <summary> Constructs a new BaseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest"> <summary> Container for the parameters to the CreateDomain operation. <para>Creates a new search domain.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResponse"> <summary> Returns information about the CreateDomainResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResponse.CreateDomainResult"> <summary> Gets and sets the CreateDomainResult property. A response message that contains the status of a newly created domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResult"> <summary> <para>A response message that contains the status of a newly created domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResult.WithDomainStatus(Amazon.CloudSearch_2011_02_01.Model.DomainStatus)"> <summary> Sets the DomainStatus property </summary> <param name="domainStatus">The value to set for the DomainStatus property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResult.DomainStatus"> <summary> The current status of the search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus"> <summary> <para>The value of the <c>DefaultSearchField</c> configured for this search domain and its current status.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus.WithOptions(System.String)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus.WithStatus(Amazon.CloudSearch_2011_02_01.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus.Options"> <summary> The name of the <c>IndexField</c> to use as the default search field. The default is an empty string, which automatically searches all text fields. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus.Status"> <summary> The status of an option, including when it was last updated and whether it is actively in use for searches. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest"> <summary> Container for the parameters to the DefineIndexField operation. <para>Configures an <c>IndexField</c> 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.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest.WithIndexField(Amazon.CloudSearch_2011_02_01.Model.IndexField)"> <summary> Sets the IndexField property </summary> <param name="indexField">The value to set for the IndexField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest.IndexField"> <summary> Defines a field in the index, including its name, type, and the source of its data. The <c>IndexFieldType</c> indicates which of the options will be present. It is invalid to specify options for a type other than the <c>IndexFieldType</c>. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResponse"> <summary> Returns information about the DefineIndexFieldResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResponse.DefineIndexFieldResult"> <summary> Gets and sets the DefineIndexFieldResult property. A response message that contains the status of an updated index field. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResult"> <summary> <para>A response message that contains the status of an updated index field.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResult.WithIndexField(Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus)"> <summary> Sets the IndexField property </summary> <param name="indexField">The value to set for the IndexField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResult.IndexField"> <summary> The value of an <c>IndexField</c> and its current status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest"> <summary> Container for the parameters to the DefineRankExpression operation. <para>Configures a <c>RankExpression</c> 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.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest.WithRankExpression(Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression)"> <summary> Sets the RankExpression property </summary> <param name="rankExpression">The value to set for the RankExpression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest.RankExpression"> <summary> A named expression that can be evaluated at search time and used for ranking or thresholding in a search query. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResponse"> <summary> Returns information about the DefineRankExpressionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResponse.DefineRankExpressionResult"> <summary> Gets and sets the DefineRankExpressionResult property. A response message that contains the status of an updated RankExpression. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResult"> <summary> <para>A response message that contains the status of an updated <c>RankExpression</c> .</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResult.WithRankExpression(Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus)"> <summary> Sets the RankExpression property </summary> <param name="rankExpression">The value to set for the RankExpression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResult.RankExpression"> <summary> The value of a <c>RankExpression</c> and its current status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest"> <summary> Container for the parameters to the DeleteDomain operation. <para>Permanently deletes a search domain and all of its data.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResponse"> <summary> Returns information about the DeleteDomainResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResponse.DeleteDomainResult"> <summary> Gets and sets the DeleteDomainResult property. A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResult"> <summary> <para>A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResult.WithDomainStatus(Amazon.CloudSearch_2011_02_01.Model.DomainStatus)"> <summary> Sets the DomainStatus property </summary> <param name="domainStatus">The value to set for the DomainStatus property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResult.DomainStatus"> <summary> The current status of the search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest"> <summary> Container for the parameters to the DeleteIndexField operation. <para>Removes an <c>IndexField</c> from the search domain.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest.WithIndexFieldName(System.String)"> <summary> Sets the IndexFieldName property </summary> <param name="indexFieldName">The value to set for the IndexFieldName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest.IndexFieldName"> <summary> A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResponse"> <summary> Returns information about the DeleteIndexFieldResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResponse.DeleteIndexFieldResult"> <summary> Gets and sets the DeleteIndexFieldResult property. A response message that contains the status of a deleted index field. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResult"> <summary> <para>A response message that contains the status of a deleted index field.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResult.WithIndexField(Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus)"> <summary> Sets the IndexField property </summary> <param name="indexField">The value to set for the IndexField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResult.IndexField"> <summary> The value of an <c>IndexField</c> and its current status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest"> <summary> Container for the parameters to the DeleteRankExpression operation. <para>Removes a <c>RankExpression</c> from the search domain.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest.WithRankName(System.String)"> <summary> Sets the RankName property </summary> <param name="rankName">The value to set for the RankName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest.RankName"> <summary> The name of the <c>RankExpression</c> to delete. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResponse"> <summary> Returns information about the DeleteRankExpressionResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResponse.DeleteRankExpressionResult"> <summary> Gets and sets the DeleteRankExpressionResult property. A response message that contains the status of a deleted RankExpression. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResult"> <summary> <para>A response message that contains the status of a deleted <c>RankExpression</c> .</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResult.WithRankExpression(Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus)"> <summary> Sets the RankExpression property </summary> <param name="rankExpression">The value to set for the RankExpression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResult.RankExpression"> <summary> The value of a <c>RankExpression</c> and its current status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest"> <summary> Container for the parameters to the DescribeDefaultSearchField operation. <para>Gets the default search field configured for the search domain.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResponse"> <summary> Returns information about the DescribeDefaultSearchFieldResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResponse.DescribeDefaultSearchFieldResult"> <summary> Gets and sets the DescribeDefaultSearchFieldResult property. A response message that contains the default search field for a search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResult"> <summary> <para>A response message that contains the default search field for a search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResult.WithDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus)"> <summary> Sets the DefaultSearchField property </summary> <param name="defaultSearchField">The value to set for the DefaultSearchField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResult.DefaultSearchField"> <summary> The name of the <c>IndexField</c> to use for search requests issued with the <c>q</c> parameter. The default is the empty string, which automatically searches all text fields. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest"> <summary> Container for the parameters to the DescribeDomains operation. <para>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest.WithDomainNames(System.String[])"> <summary> Adds elements to the DomainNames collection </summary> <param name="domainNames">The values to add to the DomainNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest.WithDomainNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the DomainNames collection </summary> <param name="domainNames">The values to add to the DomainNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest.DomainNames"> <summary> Limits the DescribeDomains response to the specified search domains. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResponse"> <summary> Returns information about the DescribeDomainsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResponse.DescribeDomainsResult"> <summary> Gets and sets the DescribeDomainsResult property. A response message that contains the status of one or more domains. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResult"> <summary> <para>A response message that contains the status of one or more domains.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResult.WithDomainStatusList(Amazon.CloudSearch_2011_02_01.Model.DomainStatus[])"> <summary> Adds elements to the DomainStatusList collection </summary> <param name="domainStatusList">The values to add to the DomainStatusList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResult.WithDomainStatusList(System.Collections.Generic.IEnumerable{Amazon.CloudSearch_2011_02_01.Model.DomainStatus})"> <summary> Adds elements to the DomainStatusList collection </summary> <param name="domainStatusList">The values to add to the DomainStatusList collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResult.DomainStatusList"> <summary> The current status of all of your search domains. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest"> <summary> Container for the parameters to the DescribeIndexFields operation. <para>Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest.WithFieldNames(System.String[])"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest.WithFieldNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest.FieldNames"> <summary> Limits the <c>DescribeIndexFields</c> response to the specified fields. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResponse"> <summary> Returns information about the DescribeIndexFieldsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResponse.DescribeIndexFieldsResult"> <summary> Gets and sets the DescribeIndexFieldsResult property. A response message that contains the index fields for a search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResult"> <summary> <para>A response message that contains the index fields for a search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResult.WithIndexFields(Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus[])"> <summary> Adds elements to the IndexFields collection </summary> <param name="indexFields">The values to add to the IndexFields collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResult.WithIndexFields(System.Collections.Generic.IEnumerable{Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus})"> <summary> Adds elements to the IndexFields collection </summary> <param name="indexFields">The values to add to the IndexFields collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResult.IndexFields"> <summary> The index fields configured for the domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest"> <summary> Container for the parameters to the DescribeRankExpressions operation. <para>Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest.WithRankNames(System.String[])"> <summary> Adds elements to the RankNames collection </summary> <param name="rankNames">The values to add to the RankNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest.WithRankNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the RankNames collection </summary> <param name="rankNames">The values to add to the RankNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest.RankNames"> <summary> Limits the <c>DescribeRankExpressions</c> response to the specified fields. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResponse"> <summary> Returns information about the DescribeRankExpressionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResponse.DescribeRankExpressionsResult"> <summary> Gets and sets the DescribeRankExpressionsResult property. A response message that contains the rank expressions for a search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResult"> <summary> <para>A response message that contains the rank expressions for a search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResult.WithRankExpressions(Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus[])"> <summary> Adds elements to the RankExpressions collection </summary> <param name="rankExpressions">The values to add to the RankExpressions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResult.WithRankExpressions(System.Collections.Generic.IEnumerable{Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus})"> <summary> Adds elements to the RankExpressions collection </summary> <param name="rankExpressions">The values to add to the RankExpressions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResult.RankExpressions"> <summary> The rank expressions configured for the domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest"> <summary> Container for the parameters to the DescribeServiceAccessPolicies operation. <para>Gets information about the resource-based policies that control access to the domain's document and search services.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResponse"> <summary> Returns information about the DescribeServiceAccessPoliciesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResponse.DescribeServiceAccessPoliciesResult"> <summary> Gets and sets the DescribeServiceAccessPoliciesResult property. A response message that contains the access policies for a domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResult"> <summary> <para>A response message that contains the access policies for a domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResult.WithAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus)"> <summary> Sets the AccessPolicies property </summary> <param name="accessPolicies">The value to set for the AccessPolicies property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResult.AccessPolicies"> <summary> A <c>PolicyDocument</c> that specifies access policies for the search domain's services, and the current status of those policies. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest"> <summary> Container for the parameters to the DescribeStemmingOptions operation. <para>Gets the stemming dictionary configured for the search domain.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResponse"> <summary> Returns information about the DescribeStemmingOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResponse.DescribeStemmingOptionsResult"> <summary> Gets and sets the DescribeStemmingOptionsResult property. A response message that contains the stemming options for a search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResult"> <summary> <para>A response message that contains the stemming options for a search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResult.WithStems(Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus)"> <summary> Sets the Stems property </summary> <param name="stems">The value to set for the Stems property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResult.Stems"> <summary> The stemming options configured for this search domain and the current status of those options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest"> <summary> Container for the parameters to the DescribeStopwordOptions operation. <para>Gets the stopwords configured for the search domain.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResponse"> <summary> Returns information about the DescribeStopwordOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResponse.DescribeStopwordOptionsResult"> <summary> Gets and sets the DescribeStopwordOptionsResult property. A response message that contains the stopword options for a search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResult"> <summary> <para>A response message that contains the stopword options for a search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResult.WithStopwords(Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus)"> <summary> Sets the Stopwords property </summary> <param name="stopwords">The value to set for the Stopwords property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResult.Stopwords"> <summary> The stopword options configured for this search domain and the current status of those options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest"> <summary> Container for the parameters to the DescribeSynonymOptions operation. <para>Gets the synonym dictionary configured for the search domain.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResponse"> <summary> Returns information about the DescribeSynonymOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResponse.DescribeSynonymOptionsResult"> <summary> Gets and sets the DescribeSynonymOptionsResult property. A response message that contains the synonym options for a search domain. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResult"> <summary> <para>A response message that contains the synonym options for a search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResult.WithSynonyms(Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus)"> <summary> Sets the Synonyms property </summary> <param name="synonyms">The value to set for the Synonyms property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResult.Synonyms"> <summary> The synonym options configured for this search domain and the current status of those options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DomainStatus"> <summary> <para>The current status of the search domain.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithDomainId(System.String)"> <summary> Sets the DomainId property </summary> <param name="domainId">The value to set for the DomainId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithCreated(System.Boolean)"> <summary> Sets the Created property </summary> <param name="created">The value to set for the Created property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithDeleted(System.Boolean)"> <summary> Sets the Deleted property </summary> <param name="deleted">The value to set for the Deleted property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithNumSearchableDocs(System.Int64)"> <summary> Sets the NumSearchableDocs property </summary> <param name="numSearchableDocs">The value to set for the NumSearchableDocs property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithDocService(Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint)"> <summary> Sets the DocService property </summary> <param name="docService">The value to set for the DocService property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithSearchService(Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint)"> <summary> Sets the SearchService property </summary> <param name="searchService">The value to set for the SearchService property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithRequiresIndexDocuments(System.Boolean)"> <summary> Sets the RequiresIndexDocuments property </summary> <param name="requiresIndexDocuments">The value to set for the RequiresIndexDocuments property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithProcessing(System.Boolean)"> <summary> Sets the Processing property </summary> <param name="processing">The value to set for the Processing property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithSearchInstanceType(System.String)"> <summary> Sets the SearchInstanceType property </summary> <param name="searchInstanceType">The value to set for the SearchInstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithSearchPartitionCount(System.Int32)"> <summary> Sets the SearchPartitionCount property </summary> <param name="searchPartitionCount">The value to set for the SearchPartitionCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.WithSearchInstanceCount(System.Int32)"> <summary> Sets the SearchInstanceCount property </summary> <param name="searchInstanceCount">The value to set for the SearchInstanceCount property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.DomainId"> <summary> An internally generated unique identifier for a domain. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.Created"> <summary> True if the search domain is created. It can take several minutes to initialize a domain when <a>CreateDomain</a> is called. Newly created search domains are returned from <a>DescribeDomains</a> with a false value for Created until domain creation is complete. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.Deleted"> <summary> True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when <a>DeleteDomain</a> is called. Newly deleted search domains are returned from <a>DescribeDomains</a> with a true value for IsDeleted for several minutes until resource cleanup is complete. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.NumSearchableDocs"> <summary> The number of documents that have been submitted to the domain and indexed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>0 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.DocService"> <summary> The service endpoint for updating documents in a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchService"> <summary> The service endpoint for requesting search results from a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.RequiresIndexDocuments"> <summary> True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.Processing"> <summary> True if processing is being done to activate the current domain configuration. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchInstanceType"> <summary> The instance type (such as search.m1.small) that is being used to process search requests. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchPartitionCount"> <summary> The number of partitions across which the search index is spread. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchInstanceCount"> <summary> The number of search instances that are available to process search requests. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest"> <summary> Container for the parameters to the IndexDocuments operation. <para>Tells the search domain to start indexing its documents using the latest text processing options and <c>IndexFields</c> . This operation must be invoked to make options whose OptionStatus has <c>OptionState</c> of <c>RequiresIndexDocuments</c> visible in search results.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResponse"> <summary> Returns information about the IndexDocumentsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResponse.IndexDocumentsResult"> <summary> Gets and sets the IndexDocumentsResult property. The result of an IndexDocuments action. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResult"> <summary> <para>The result of an <c>IndexDocuments</c> action.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResult.WithFieldNames(System.String[])"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResult.WithFieldNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the FieldNames collection </summary> <param name="fieldNames">The values to add to the FieldNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResult.FieldNames"> <summary> The names of the fields that are currently being processed due to an <c>IndexDocuments</c> action. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexField"> <summary> <para>Defines a field in the index, including its name, type, and the source of its data. The <c>IndexFieldType</c> indicates which of the options will be present. It is invalid to specify options for a type other than the <c>IndexFieldType</c> .</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexField.WithIndexFieldName(System.String)"> <summary> Sets the IndexFieldName property </summary> <param name="indexFieldName">The value to set for the IndexFieldName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexField.WithIndexFieldType(System.String)"> <summary> Sets the IndexFieldType property </summary> <param name="indexFieldType">The value to set for the IndexFieldType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexField.WithUIntOptions(Amazon.CloudSearch_2011_02_01.Model.UIntOptions)"> <summary> Sets the UIntOptions property </summary> <param name="uIntOptions">The value to set for the UIntOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexField.WithLiteralOptions(Amazon.CloudSearch_2011_02_01.Model.LiteralOptions)"> <summary> Sets the LiteralOptions property </summary> <param name="literalOptions">The value to set for the LiteralOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexField.WithTextOptions(Amazon.CloudSearch_2011_02_01.Model.TextOptions)"> <summary> Sets the TextOptions property </summary> <param name="textOptions">The value to set for the TextOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexField.WithSourceAttributes(Amazon.CloudSearch_2011_02_01.Model.SourceAttribute[])"> <summary> Adds elements to the SourceAttributes collection </summary> <param name="sourceAttributes">The values to add to the SourceAttributes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexField.WithSourceAttributes(System.Collections.Generic.IEnumerable{Amazon.CloudSearch_2011_02_01.Model.SourceAttribute})"> <summary> Adds elements to the SourceAttributes collection </summary> <param name="sourceAttributes">The values to add to the SourceAttributes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.IndexFieldName"> <summary> The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.IndexFieldType"> <summary> The type of field. Based on this type, exactly one of the <a>UIntOptions</a>, <a>LiteralOptions</a> or <a>TextOptions</a> must be present. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>uint, literal, text</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.UIntOptions"> <summary> Options for an unsigned integer field. Present if <c>IndexFieldType</c> specifies the field is of type unsigned integer. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.LiteralOptions"> <summary> Options for literal field. Present if <c>IndexFieldType</c> specifies the field is of type literal. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.TextOptions"> <summary> Options for text field. Present if <c>IndexFieldType</c> specifies the field is of type text. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.SourceAttributes"> <summary> An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this <c>IndexField</c>. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an <c>IndexField</c>. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus"> <summary> <para>The value of an <c>IndexField</c> and its current status.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus.WithOptions(Amazon.CloudSearch_2011_02_01.Model.IndexField)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus.WithStatus(Amazon.CloudSearch_2011_02_01.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus.Options"> <summary> Defines a field in the index, including its name, type, and the source of its data. The <c>IndexFieldType</c> indicates which of the options will be present. It is invalid to specify options for a type other than the <c>IndexFieldType</c>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus.Status"> <summary> The status of an option, including when it was last updated and whether it is actively in use for searches. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.InternalException.#ctor(System.String)"> <summary> Constructs a new InternalException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.AccessPoliciesStatusUnmarshaller"> <summary> AccessPoliciesStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.CreateDomainRequestMarshaller"> <summary> Create Domain Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.CreateDomainResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDomain operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.CreateDomainResultUnmarshaller"> <summary> CreateDomainResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefaultSearchFieldStatusUnmarshaller"> <summary> DefaultSearchFieldStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefineIndexFieldRequestMarshaller"> <summary> Define Index Field Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefineIndexFieldResponseUnmarshaller"> <summary> Response Unmarshaller for DefineIndexField operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefineIndexFieldResultUnmarshaller"> <summary> DefineIndexFieldResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefineRankExpressionRequestMarshaller"> <summary> Define Rank Expression Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefineRankExpressionResponseUnmarshaller"> <summary> Response Unmarshaller for DefineRankExpression operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefineRankExpressionResultUnmarshaller"> <summary> DefineRankExpressionResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteDomainRequestMarshaller"> <summary> Delete Domain Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteDomainResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDomain operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteDomainResultUnmarshaller"> <summary> DeleteDomainResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteIndexFieldRequestMarshaller"> <summary> Delete Index Field Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteIndexFieldResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteIndexField operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteIndexFieldResultUnmarshaller"> <summary> DeleteIndexFieldResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteRankExpressionRequestMarshaller"> <summary> Delete Rank Expression Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteRankExpressionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteRankExpression operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DeleteRankExpressionResultUnmarshaller"> <summary> DeleteRankExpressionResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeDefaultSearchFieldRequestMarshaller"> <summary> Describe Default Search Field Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeDefaultSearchFieldResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDefaultSearchField operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeDefaultSearchFieldResultUnmarshaller"> <summary> DescribeDefaultSearchFieldResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeDomainsRequestMarshaller"> <summary> Describe Domains Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeDomainsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDomains operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeDomainsResultUnmarshaller"> <summary> DescribeDomainsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeIndexFieldsRequestMarshaller"> <summary> Describe Index Fields Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeIndexFieldsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeIndexFields operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeIndexFieldsResultUnmarshaller"> <summary> DescribeIndexFieldsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeRankExpressionsRequestMarshaller"> <summary> Describe Rank Expressions Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeRankExpressionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeRankExpressions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeRankExpressionsResultUnmarshaller"> <summary> DescribeRankExpressionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeServiceAccessPoliciesRequestMarshaller"> <summary> Describe Service Access Policies Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeServiceAccessPoliciesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeServiceAccessPolicies operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeServiceAccessPoliciesResultUnmarshaller"> <summary> DescribeServiceAccessPoliciesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeStemmingOptionsRequestMarshaller"> <summary> Describe Stemming Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeStemmingOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStemmingOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeStemmingOptionsResultUnmarshaller"> <summary> DescribeStemmingOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeStopwordOptionsRequestMarshaller"> <summary> Describe Stopword Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeStopwordOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStopwordOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeStopwordOptionsResultUnmarshaller"> <summary> DescribeStopwordOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeSynonymOptionsRequestMarshaller"> <summary> Describe Synonym Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeSynonymOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSynonymOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeSynonymOptionsResultUnmarshaller"> <summary> DescribeSynonymOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DomainStatusUnmarshaller"> <summary> DomainStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.IndexDocumentsRequestMarshaller"> <summary> Index Documents Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.IndexDocumentsResponseUnmarshaller"> <summary> Response Unmarshaller for IndexDocuments operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.IndexDocumentsResultUnmarshaller"> <summary> IndexDocumentsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.IndexFieldStatusUnmarshaller"> <summary> IndexFieldStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.IndexFieldUnmarshaller"> <summary> IndexField Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.LiteralOptionsUnmarshaller"> <summary> LiteralOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.NamedRankExpressionUnmarshaller"> <summary> NamedRankExpression Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.OptionStatusUnmarshaller"> <summary> OptionStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.RankExpressionStatusUnmarshaller"> <summary> RankExpressionStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.ServiceEndpointUnmarshaller"> <summary> ServiceEndpoint Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceAttributeUnmarshaller"> <summary> SourceAttribute Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceDataMapUnmarshaller"> <summary> SourceDataMap Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceDataTrimTitleUnmarshaller"> <summary> SourceDataTrimTitle Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceDataUnmarshaller"> <summary> SourceData Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.StemmingOptionsStatusUnmarshaller"> <summary> StemmingOptionsStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.StopwordOptionsStatusUnmarshaller"> <summary> StopwordOptionsStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SynonymOptionsStatusUnmarshaller"> <summary> SynonymOptionsStatus Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.TextOptionsUnmarshaller"> <summary> TextOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UIntOptionsUnmarshaller"> <summary> UIntOptions Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateDefaultSearchFieldRequestMarshaller"> <summary> Update Default Search Field Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateDefaultSearchFieldResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateDefaultSearchField operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateDefaultSearchFieldResultUnmarshaller"> <summary> UpdateDefaultSearchFieldResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateServiceAccessPoliciesRequestMarshaller"> <summary> Update Service Access Policies Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateServiceAccessPoliciesResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateServiceAccessPolicies operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateServiceAccessPoliciesResultUnmarshaller"> <summary> UpdateServiceAccessPoliciesResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateStemmingOptionsRequestMarshaller"> <summary> Update Stemming Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateStemmingOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateStemmingOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateStemmingOptionsResultUnmarshaller"> <summary> UpdateStemmingOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateStopwordOptionsRequestMarshaller"> <summary> Update Stopword Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateStopwordOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateStopwordOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateStopwordOptionsResultUnmarshaller"> <summary> UpdateStopwordOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateSynonymOptionsRequestMarshaller"> <summary> Update Synonym Options Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateSynonymOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateSynonymOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateSynonymOptionsResultUnmarshaller"> <summary> UpdateSynonymOptionsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException.#ctor(System.String)"> <summary> Constructs a new InvalidTypeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions"> <summary> <para>Options that define a literal field in the search index.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.WithSearchEnabled(System.Boolean)"> <summary> Sets the SearchEnabled property </summary> <param name="searchEnabled">The value to set for the SearchEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.WithResultEnabled(System.Boolean)"> <summary> Sets the ResultEnabled property </summary> <param name="resultEnabled">The value to set for the ResultEnabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.DefaultValue"> <summary> The default value for a literal field. Optional. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.SearchEnabled"> <summary> Specifies whether search is enabled for this field. Default: False. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.FacetEnabled"> <summary> Specifies whether facets are enabled for this field. Default: False. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.ResultEnabled"> <summary> Specifies whether values of this field can be returned in search results and used for ranking. Default: False. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression"> <summary> <para>A named expression that can be evaluated at search time and used for ranking or thresholding in a search query. </para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression.WithRankName(System.String)"> <summary> Sets the RankName property </summary> <param name="rankName">The value to set for the RankName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression.WithRankExpression(System.String)"> <summary> Sets the RankExpression property </summary> <param name="rankExpression">The value to set for the RankExpression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression.RankName"> <summary> The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression.RankExpression"> <summary> The expression to evaluate for ranking or thresholding while processing a search request. The <c>RankExpression</c> syntax is based on JavaScript expressions and supports:<ul> <li>Integer, floating point, hex and octal literals</li> <li>Shortcut evaluation of logical operators such that an expression <c>a || b</c> evaluates to the value <c>a</c>, if <c>a</c> is true, without evaluating <c>b</c> at all</li> <li>JavaScript order of precedence for operators</li> <li>Arithmetic operators: <c>+ - * / %</c></li> <li>Boolean operators (including the ternary operator)</li> <li>Bitwise operators</li> <li>Comparison operators</li> <li>Common mathematic functions: <c>abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow</c></li> <li>Trigonometric library functions: <c>acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan</c></li> <li>Random generation of a number between 0 and 1: <c>rand</c></li> <li>Current time in epoch: <c>time</c></li> <li>The <c>min max</c> functions that operate on a variable argument list</li> </ul> Intermediate results are calculated as double precision floating point values. The final return value of a <c>RankExpression</c> is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0. The source data for a <c>RankExpression</c> can be the name of an <c>IndexField</c> of type uint, another <c>RankExpression</c> or the reserved name <i>text_relevance</i>. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching <c>IndexField</c> in the document. For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 10240</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.OptionStatus"> <summary> <para>The status of an option, including when it was last updated and whether it is actively in use for searches.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.WithCreationDate(System.DateTime)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.WithUpdateDate(System.DateTime)"> <summary> Sets the UpdateDate property </summary> <param name="updateDate">The value to set for the UpdateDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.WithUpdateVersion(System.Int32)"> <summary> Sets the UpdateVersion property </summary> <param name="updateVersion">The value to set for the UpdateVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.WithPendingDeletion(System.Boolean)"> <summary> Sets the PendingDeletion property </summary> <param name="pendingDeletion">The value to set for the PendingDeletion property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.CreationDate"> <summary> A timestamp for when this option was created. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.UpdateDate"> <summary> A timestamp for when this option was last updated. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.UpdateVersion"> <summary> A unique integer that indicates when this option was last updated. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>0 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.State"> <summary> The state of processing a change to an option. Possible values:<ul> <li><c>RequiresIndexDocuments</c>: the option's latest value will not be visible in searches until <a>IndexDocuments</a> has been called and indexing is complete.</li> <li><c>Processing</c>: the option's latest value is not yet visible in all searches but is in the process of being activated. </li> <li><c>Active</c>: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in <c>Diagnostics</c>.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>RequiresIndexDocuments, Processing, Active</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.PendingDeletion"> <summary> Indicates that the option will be deleted once processing is complete. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus"> <summary> <para>The value of a <c>RankExpression</c> and its current status.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus.WithOptions(Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus.WithStatus(Amazon.CloudSearch_2011_02_01.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus.Options"> <summary> The expression that is evaluated for ranking or thresholding while processing a search request. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus.Status"> <summary> The status of an option, including when it was last updated and whether it is actively in use for searches. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> <summary> AmazonCloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ResourceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint"> <summary> <para>The endpoint to which service requests can be submitted, including the actual URL prefix for sending requests and the Amazon Resource Name (ARN) so the endpoint can be referenced in other API calls such as UpdateServiceAccessPolicies.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint.WithArn(System.String)"> <summary> Sets the Arn property </summary> <param name="arn">The value to set for the Arn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint.WithEndpoint(System.String)"> <summary> Sets the Endpoint property </summary> <param name="endpoint">The value to set for the Endpoint property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint.Arn"> <summary> An Amazon Resource Name (ARN). See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint.Endpoint"> <summary> The URL (including /version/pathPrefix) to which service requests can be submitted. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute"> <summary> <para>Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.WithSourceDataFunction(System.String)"> <summary> Sets the SourceDataFunction property </summary> <param name="sourceDataFunction">The value to set for the SourceDataFunction property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.WithSourceDataCopy(Amazon.CloudSearch_2011_02_01.Model.SourceData)"> <summary> Sets the SourceDataCopy property </summary> <param name="sourceDataCopy">The value to set for the SourceDataCopy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.WithSourceDataTrimTitle(Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle)"> <summary> Sets the SourceDataTrimTitle property </summary> <param name="sourceDataTrimTitle">The value to set for the SourceDataTrimTitle property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.WithSourceDataMap(Amazon.CloudSearch_2011_02_01.Model.SourceDataMap)"> <summary> Sets the SourceDataMap property </summary> <param name="sourceDataMap">The value to set for the SourceDataMap property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataFunction"> <summary> Identifies the transformation to apply when copying data from a source attribute. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>Copy, TrimTitle, Map</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataCopy"> <summary> Copies data from a source document attribute to an <c>IndexField</c>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataTrimTitle"> <summary> Trims common title words from a source document attribute when populating an <c>IndexField</c>. This can be used to create an <c>IndexField</c> you can use for sorting. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataMap"> <summary> Maps source document attribute values to new values when populating the <c>IndexField</c>. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceData"> <summary> <para>The source attribute name and an optional default value to use if a document doesn't have an attribute of that name.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceData.WithSourceName(System.String)"> <summary> Sets the SourceName property </summary> <param name="sourceName">The value to set for the SourceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceData.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceData.SourceName"> <summary> The name of the document source field to add to this <c>IndexField</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceData.DefaultValue"> <summary> The default value to use if the source attribute is not specified in a document. Optional. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap"> <summary> <para>Specifies how to map source attribute values to custom values when populating an <c>IndexField</c> .</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.WithSourceName(System.String)"> <summary> Sets the SourceName property </summary> <param name="sourceName">The value to set for the SourceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.WithCases(System.Collections.Generic.KeyValuePair{System.String,System.String}[])"> <summary> Adds the KeyValuePairs to the Cases dictionary. </summary> <param name="pairs">The pairs to be added to the Cases dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.SourceName"> <summary> The name of the document source field to add to this <c>IndexField</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.DefaultValue"> <summary> The default value to use if the source attribute is not specified in a document. Optional. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.Cases"> <summary> A map that translates source field values to custom values. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle"> <summary> <para>Specifies how to trim common words from the beginning of a field to enable title sorting by that field.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.WithSourceName(System.String)"> <summary> Sets the SourceName property </summary> <param name="sourceName">The value to set for the SourceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.WithSeparator(System.String)"> <summary> Sets the Separator property </summary> <param name="separator">The value to set for the Separator property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.SourceName"> <summary> The name of the document source field to add to this <c>IndexField</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.DefaultValue"> <summary> The default value to use if the source attribute is not specified in a document. Optional. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.Separator"> <summary> The separator that follows the text to trim. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.Language"> <summary> An <a href="http://tools.ietf.org/html/rfc4646">IETF RFC 4646</a> language code. Only the primary language is considered. English (en) is currently the only supported language. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Pattern</term> <description>[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus"> <summary> <para>The stemming options configured for this search domain and the current status of those options.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus.WithOptions(System.String)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus.WithStatus(Amazon.CloudSearch_2011_02_01.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus.Options"> <summary> Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: <c>{ "stems": {"people": "person", "walking": "walk"} }</c> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus.Status"> <summary> The status of an option, including when it was last updated and whether it is actively in use for searches. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus"> <summary> <para>The stopword options configured for this search domain and the current status of those options.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus.WithOptions(System.String)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus.WithStatus(Amazon.CloudSearch_2011_02_01.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus.Options"> <summary> Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: <c>{ "stopwords": ["a", "an", "the", "of"] }</c> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus.Status"> <summary> The status of an option, including when it was last updated and whether it is actively in use for searches. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus"> <summary> <para>The synonym options configured for this search domain and the current status of those options.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus.WithOptions(System.String)"> <summary> Sets the Options property </summary> <param name="options">The value to set for the Options property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus.WithStatus(Amazon.CloudSearch_2011_02_01.Model.OptionStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus.Options"> <summary> Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: <c>{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }</c> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus.Status"> <summary> The status of an option, including when it was last updated and whether it is actively in use for searches. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.TextOptions"> <summary> <para>Options that define a text field in the search index.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.TextOptions.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.TextOptions.WithFacetEnabled(System.Boolean)"> <summary> Sets the FacetEnabled property </summary> <param name="facetEnabled">The value to set for the FacetEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.TextOptions.WithResultEnabled(System.Boolean)"> <summary> Sets the ResultEnabled property </summary> <param name="resultEnabled">The value to set for the ResultEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.TextOptions.WithTextProcessor(System.String)"> <summary> Sets the TextProcessor property </summary> <param name="textProcessor">The value to set for the TextProcessor property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.DefaultValue"> <summary> The default value for a text field. Optional. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.FacetEnabled"> <summary> Specifies whether facets are enabled for this field. Default: False. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.ResultEnabled"> <summary> Specifies whether values of this field can be returned in search results and used for ranking. Default: False. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.TextProcessor"> <summary> The text processor to apply to this field. Optional. Possible values: <ul> <li><c>cs_text_no_stemming</c>: turns off stemming for the field.</li> </ul> Default: none <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 64</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9_]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UIntOptions"> <summary> <para>Options that define a <c>uint</c> field in the search index.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UIntOptions.WithDefaultValue(System.Int32)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UIntOptions.DefaultValue"> <summary> The default value for an unsigned integer field. Optional. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>0 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest"> <summary> Container for the parameters to the UpdateDefaultSearchField operation. <para>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. </para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest.WithDefaultSearchField(System.String)"> <summary> Sets the DefaultSearchField property </summary> <param name="defaultSearchField">The value to set for the DefaultSearchField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest.DefaultSearchField"> <summary> The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the <c>q</c> parameter, or if a match expression specified with the <c>bq</c> parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResponse"> <summary> Returns information about the UpdateDefaultSearchFieldResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResponse.UpdateDefaultSearchFieldResult"> <summary> Gets and sets the UpdateDefaultSearchFieldResult property. A response message that contains the status of an updated default search field. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResult"> <summary> <para>A response message that contains the status of an updated default search field.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResult.WithDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus)"> <summary> Sets the DefaultSearchField property </summary> <param name="defaultSearchField">The value to set for the DefaultSearchField property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResult.DefaultSearchField"> <summary> The value of the <c>DefaultSearchField</c> configured for this search domain and its current status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest"> <summary> Container for the parameters to the UpdateServiceAccessPolicies operation. <para>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.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest.WithAccessPolicies(System.String)"> <summary> Sets the AccessPolicies property </summary> <param name="accessPolicies">The value to set for the AccessPolicies property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest.AccessPolicies"> <summary> An IAM access policy as described in <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?AccessPolicyLanguage.html" target="_blank">The Access Policy Language</a> in <i>Using AWS Identity and Access Management</i>. The maximum size of an access policy document is 100 KB. Example: <c>{"Statement": [{"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }}, {"Effect":"Allow", "Action": "*", "Resource": "arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": { "IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }</c> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResponse"> <summary> Returns information about the UpdateServiceAccessPoliciesResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResponse.UpdateServiceAccessPoliciesResult"> <summary> Gets and sets the UpdateServiceAccessPoliciesResult property. A response message that contains the status of updated access policies. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResult"> <summary> <para>A response message that contains the status of updated access policies.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResult.WithAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus)"> <summary> Sets the AccessPolicies property </summary> <param name="accessPolicies">The value to set for the AccessPolicies property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResult.AccessPolicies"> <summary> A <c>PolicyDocument</c> that specifies access policies for the search domain's services, and the current status of those policies. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest"> <summary> Container for the parameters to the UpdateStemmingOptions operation. <para>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.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest.WithStems(System.String)"> <summary> Sets the Stems property </summary> <param name="stems">The value to set for the Stems property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest.Stems"> <summary> Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: <c>{ "stems": {"people": "person", "walking": "walk"} }</c> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResponse"> <summary> Returns information about the UpdateStemmingOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResponse.UpdateStemmingOptionsResult"> <summary> Gets and sets the UpdateStemmingOptionsResult property. A response message that contains the status of updated stemming options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResult"> <summary> <para>A response message that contains the status of updated stemming options.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResult.WithStems(Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus)"> <summary> Sets the Stems property </summary> <param name="stems">The value to set for the Stems property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResult.Stems"> <summary> The stemming options configured for this search domain and the current status of those options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest"> <summary> Container for the parameters to the UpdateStopwordOptions operation. <para>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.</para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest.WithStopwords(System.String)"> <summary> Sets the Stopwords property </summary> <param name="stopwords">The value to set for the Stopwords property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest.Stopwords"> <summary> Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: <c>{ "stopwords": ["a", "an", "the", "of"] }</c> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResponse"> <summary> Returns information about the UpdateStopwordOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResponse.UpdateStopwordOptionsResult"> <summary> Gets and sets the UpdateStopwordOptionsResult property. A response message that contains the status of updated stopword options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResult"> <summary> <para>A response message that contains the status of updated stopword options.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResult.WithStopwords(Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus)"> <summary> Sets the Stopwords property </summary> <param name="stopwords">The value to set for the Stopwords property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResult.Stopwords"> <summary> The stopword options configured for this search domain and the current status of those options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest"> <summary> Container for the parameters to the UpdateSynonymOptions operation. <para>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. </para> </summary> <seealso cref="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"/> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest.WithDomainName(System.String)"> <summary> Sets the DomainName property </summary> <param name="domainName">The value to set for the DomainName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest.WithSynonyms(System.String)"> <summary> Sets the Synonyms property </summary> <param name="synonyms">The value to set for the Synonyms property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest.DomainName"> <summary> A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 28</description> </item> <item> <term>Pattern</term> <description>[a-z][a-z0-9\-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest.Synonyms"> <summary> Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: <c>{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }</c> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResponse"> <summary> Returns information about the UpdateSynonymOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResponse.UpdateSynonymOptionsResult"> <summary> Gets and sets the UpdateSynonymOptionsResult property. A response message that contains the status of updated synonym options. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResult"> <summary> <para>A response message that contains the status of updated synonym options.</para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResult.WithSynonyms(Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus)"> <summary> Sets the Synonyms property </summary> <param name="synonyms">The value to set for the Synonyms property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResult.Synonyms"> <summary> The synonym options configured for this search domain and the current status of those options. </summary> </member> <member name="T:Amazon.CloudTrail.AmazonCloudTrail"> <summary> Interface for accessing AmazonCloudTrail. AWS Cloud Trail <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> <para><b>NOTE:</b> 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 Tools for Amazon Web Services page. </para> <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.AmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"> <summary> <para>Returns a JSON-formatted list of information about the specified trail. Fields include information such as delivery errors, Amazon SNS and Amazon S3 errors, and times that logging started and stopped for each trail.</para> </summary> <param name="getTrailStatusRequest">Container for the necessary parameters to execute the GetTrailStatus service method on AmazonCloudTrail.</param> <returns>The response from the GetTrailStatus service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.BeginGetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTrailStatus operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"/> </summary> <param name="getTrailStatusRequest">Container for the necessary parameters to execute the GetTrailStatus operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTrailStatus operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.EndGetTrailStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTrailStatus operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTrailStatus.</param> <returns>Returns a GetTrailStatusResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"> <summary> <para>Deletes a trail.</para> </summary> <param name="deleteTrailRequest">Container for the necessary parameters to execute the DeleteTrail service method on AmazonCloudTrail.</param> <returns>The response from the DeleteTrail service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.BeginDeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"/> </summary> <param name="deleteTrailRequest">Container for the necessary parameters to execute the DeleteTrail operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTrail operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.EndDeleteTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTrail.</param> <returns>Returns a DeleteTrailResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"> <summary> <para>From the command line, use create-subscription. </para> <para>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. The request includes a Trail structure that specifies the following:</para> <ul> <li>Trail name.</li> <li>The name of an existing Amazon S3 bucket to which CloudTrail delivers your log files.</li> <li>The name of the Amazon S3 key prefix that precedes each log file.</li> <li>The name of an existing Amazon SNS topic that notifies you that a new file is available in your bucket.</li> <li>Whether the log file should include AWS API calls from global services. Currently, the only global AWS API calls included in CloudTrail log files are from IAM and AWS STS.</li> </ul> </summary> <param name="createTrailRequest">Container for the necessary parameters to execute the CreateTrail service method on AmazonCloudTrail.</param> <returns>The response from the CreateTrail service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"/> <exception cref="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.BeginCreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"/> </summary> <param name="createTrailRequest">Container for the necessary parameters to execute the CreateTrail operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTrail operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.EndCreateTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTrail.</param> <returns>Returns a CreateTrailResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"> <summary> <para>From the command line, use update-subscription.</para> <para>Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. You 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. Use a Trail data type to pass updated bucket or topic names.</para> </summary> <param name="updateTrailRequest">Container for the necessary parameters to execute the UpdateTrail service method on AmazonCloudTrail.</param> <returns>The response from the UpdateTrail service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.BeginUpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"/> </summary> <param name="updateTrailRequest">Container for the necessary parameters to execute the UpdateTrail operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateTrail operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.EndUpdateTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTrail.</param> <returns>Returns a UpdateTrailResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"> <summary> <para>Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.</para> </summary> <param name="describeTrailsRequest">Container for the necessary parameters to execute the DescribeTrails service method on AmazonCloudTrail.</param> <returns>The response from the DescribeTrails service method, as returned by AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.BeginDescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrails operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"/> </summary> <param name="describeTrailsRequest">Container for the necessary parameters to execute the DescribeTrails operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrails operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.EndDescribeTrails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrails operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrails.</param> <returns>Returns a DescribeTrailsResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.DescribeTrails"> <summary> <para>Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.</para> </summary> <returns>The response from the DescribeTrails service method, as returned by AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"> <summary> <para>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.</para> </summary> <param name="stopLoggingRequest">Container for the necessary parameters to execute the StopLogging service method on AmazonCloudTrail.</param> <returns>The response from the StopLogging service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.BeginStopLogging(Amazon.CloudTrail.Model.StopLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"/> </summary> <param name="stopLoggingRequest">Container for the necessary parameters to execute the StopLogging operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopLogging operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.EndStopLogging(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopLogging.</param> <returns>Returns a StopLoggingResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"> <summary> <para>Starts the recording of AWS API calls and log file delivery for a trail.</para> </summary> <param name="startLoggingRequest">Container for the necessary parameters to execute the StartLogging service method on AmazonCloudTrail.</param> <returns>The response from the StartLogging service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.BeginStartLogging(Amazon.CloudTrail.Model.StartLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"/> </summary> <param name="startLoggingRequest">Container for the necessary parameters to execute the StartLogging operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartLogging operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrail.EndStartLogging(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartLogging.</param> <returns>Returns a StartLoggingResult from AmazonCloudTrail.</returns> </member> <member name="T:Amazon.CloudTrail.AmazonCloudTrailClient"> <summary> Implementation for accessing AmazonCloudTrail. AWS Cloud Trail <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> <para><b>NOTE:</b> 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 Tools for Amazon Web Services page. </para> <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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudTrail 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"> <summary> <para>Returns a JSON-formatted list of information about the specified trail. Fields include information such as delivery errors, Amazon SNS and Amazon S3 errors, and times that logging started and stopped for each trail.</para> </summary> <param name="getTrailStatusRequest">Container for the necessary parameters to execute the GetTrailStatus service method on AmazonCloudTrail.</param> <returns>The response from the GetTrailStatus service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginGetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTrailStatus operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"/> </summary> <param name="getTrailStatusRequest">Container for the necessary parameters to execute the GetTrailStatus operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTrailStatus operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndGetTrailStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTrailStatus operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTrailStatus.</param> <returns>Returns a GetTrailStatusResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"> <summary> <para>Deletes a trail.</para> </summary> <param name="deleteTrailRequest">Container for the necessary parameters to execute the DeleteTrail service method on AmazonCloudTrail.</param> <returns>The response from the DeleteTrail service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginDeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"/> </summary> <param name="deleteTrailRequest">Container for the necessary parameters to execute the DeleteTrail operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTrail operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndDeleteTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTrail.</param> <returns>Returns a DeleteTrailResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"> <summary> <para>From the command line, use create-subscription. </para> <para>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. The request includes a Trail structure that specifies the following:</para> <ul> <li>Trail name.</li> <li>The name of an existing Amazon S3 bucket to which CloudTrail delivers your log files.</li> <li>The name of the Amazon S3 key prefix that precedes each log file.</li> <li>The name of an existing Amazon SNS topic that notifies you that a new file is available in your bucket.</li> <li>Whether the log file should include AWS API calls from global services. Currently, the only global AWS API calls included in CloudTrail log files are from IAM and AWS STS.</li> </ul> </summary> <param name="createTrailRequest">Container for the necessary parameters to execute the CreateTrail service method on AmazonCloudTrail.</param> <returns>The response from the CreateTrail service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"/> <exception cref="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginCreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"/> </summary> <param name="createTrailRequest">Container for the necessary parameters to execute the CreateTrail operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTrail operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndCreateTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTrail.</param> <returns>Returns a CreateTrailResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"> <summary> <para>From the command line, use update-subscription.</para> <para>Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. You 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. Use a Trail data type to pass updated bucket or topic names.</para> </summary> <param name="updateTrailRequest">Container for the necessary parameters to execute the UpdateTrail service method on AmazonCloudTrail.</param> <returns>The response from the UpdateTrail service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"/> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"/> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginUpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"/> </summary> <param name="updateTrailRequest">Container for the necessary parameters to execute the UpdateTrail operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateTrail operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndUpdateTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTrail operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTrail.</param> <returns>Returns a UpdateTrailResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"> <summary> <para>Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.</para> </summary> <param name="describeTrailsRequest">Container for the necessary parameters to execute the DescribeTrails service method on AmazonCloudTrail.</param> <returns>The response from the DescribeTrails service method, as returned by AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginDescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrails operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"/> </summary> <param name="describeTrailsRequest">Container for the necessary parameters to execute the DescribeTrails operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrails operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndDescribeTrails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrails operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrails.</param> <returns>Returns a DescribeTrailsResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DescribeTrails"> <summary> <para>Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.</para> </summary> <returns>The response from the DescribeTrails service method, as returned by AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"> <summary> <para>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.</para> </summary> <param name="stopLoggingRequest">Container for the necessary parameters to execute the StopLogging service method on AmazonCloudTrail.</param> <returns>The response from the StopLogging service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginStopLogging(Amazon.CloudTrail.Model.StopLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"/> </summary> <param name="stopLoggingRequest">Container for the necessary parameters to execute the StopLogging operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopLogging operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndStopLogging(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopLogging.</param> <returns>Returns a StopLoggingResult from AmazonCloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"> <summary> <para>Starts the recording of AWS API calls and log file delivery for a trail.</para> </summary> <param name="startLoggingRequest">Container for the necessary parameters to execute the StartLogging service method on AmazonCloudTrail.</param> <returns>The response from the StartLogging service method, as returned by AmazonCloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"/> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"/> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginStartLogging(Amazon.CloudTrail.Model.StartLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"/> </summary> <param name="startLoggingRequest">Container for the necessary parameters to execute the StartLogging operation on AmazonCloudTrail.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartLogging operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndStartLogging(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartLogging operation. <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartLogging.</param> <returns>Returns a StartLoggingResult from AmazonCloudTrail.</returns> </member> <member name="T:Amazon.CloudTrail.AmazonCloudTrailConfig"> <summary> Configuration for accessing AWS Cloud Trail service </summary> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudTrail.AmazonCloudTrailConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudTrail.AmazonCloudTrailConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CloudTrail.Model.CreateTrailRequest"> <summary> Container for the parameters to the CreateTrail operation. <para>From the command line, use create-subscription. </para> <para>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. The request includes a Trail structure that specifies the following:</para> <ul> <li>Trail name.</li> <li>The name of an existing Amazon S3 bucket to which CloudTrail delivers your log files.</li> <li>The name of the Amazon S3 key prefix that precedes each log file.</li> <li>The name of an existing Amazon SNS topic that notifies you that a new file is available in your bucket.</li> <li>Whether the log file should include AWS API calls from global services. Currently, the only global AWS API calls included in CloudTrail log files are from IAM and AWS STS.</li> </ul> </summary> <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"/> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailRequest.WithS3BucketName(System.String)"> <summary> Sets the S3BucketName property </summary> <param name="s3BucketName">The value to set for the S3BucketName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailRequest.WithS3KeyPrefix(System.String)"> <summary> Sets the S3KeyPrefix property </summary> <param name="s3KeyPrefix">The value to set for the S3KeyPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailRequest.WithSnsTopicName(System.String)"> <summary> Sets the SnsTopicName property </summary> <param name="snsTopicName">The value to set for the SnsTopicName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailRequest.WithIncludeGlobalServiceEvents(System.Boolean)"> <summary> Sets the IncludeGlobalServiceEvents property </summary> <param name="includeGlobalServiceEvents">The value to set for the IncludeGlobalServiceEvents property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailRequest.WithTrail(Amazon.CloudTrail.Model.Trail)"> <summary> Sets the Trail property </summary> <param name="trail">The value to set for the Trail property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.Trail"> <summary> Contains the <a>Trail</a> structure that specifies the settings for each trail. </summary> </member> <member name="T:Amazon.CloudTrail.Model.CreateTrailResponse"> <summary> Returns information about the CreateTrailResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResponse.CreateTrailResult"> <summary> Gets and sets the CreateTrailResult property. A JSON-formatted Trail object that represents the settings for the requested trail. </summary> </member> <member name="T:Amazon.CloudTrail.Model.CreateTrailResult"> <summary> <para>A JSON-formatted Trail object that represents the settings for the requested trail.</para> </summary> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailResult.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailResult.WithS3BucketName(System.String)"> <summary> Sets the S3BucketName property </summary> <param name="s3BucketName">The value to set for the S3BucketName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailResult.WithS3KeyPrefix(System.String)"> <summary> Sets the S3KeyPrefix property </summary> <param name="s3KeyPrefix">The value to set for the S3KeyPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailResult.WithSnsTopicName(System.String)"> <summary> Sets the SnsTopicName property </summary> <param name="snsTopicName">The value to set for the SnsTopicName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailResult.WithIncludeGlobalServiceEvents(System.Boolean)"> <summary> Sets the IncludeGlobalServiceEvents property </summary> <param name="includeGlobalServiceEvents">The value to set for the IncludeGlobalServiceEvents property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.CreateTrailResult.WithTrail(Amazon.CloudTrail.Model.Trail)"> <summary> Sets the Trail property </summary> <param name="trail">The value to set for the Trail property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.Trail"> <summary> Data type that represents the settings for a trail. </summary> </member> <member name="T:Amazon.CloudTrail.Model.DeleteTrailRequest"> <summary> Container for the parameters to the DeleteTrail operation. <para>Deletes a trail.</para> </summary> <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"/> </member> <member name="M:Amazon.CloudTrail.Model.DeleteTrailRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.DeleteTrailRequest.Name"> <summary> The name of a trail to be deleted. </summary> </member> <member name="T:Amazon.CloudTrail.Model.DeleteTrailResponse"> <summary> Returns information about the DeleteTrailResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudTrail.Model.DeleteTrailResponse.DeleteTrailResult"> <summary> Gets and sets the DeleteTrailResult property. Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.CloudTrail.Model.DeleteTrailResult"> <summary> <para>Returns the objects or data listed below if successful. Otherwise, returns an error.</para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.DescribeTrailsRequest"> <summary> Container for the parameters to the DescribeTrails operation. <para>Retrieves the settings for some or all trails associated with an account. Returns a list of Trail structures in JSON format.</para> </summary> <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"/> </member> <member name="M:Amazon.CloudTrail.Model.DescribeTrailsRequest.WithTrailNameList(System.String[])"> <summary> Adds elements to the TrailNameList collection </summary> <param name="trailNameList">The values to add to the TrailNameList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.DescribeTrailsRequest.WithTrailNameList(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the TrailNameList collection </summary> <param name="trailNameList">The values to add to the TrailNameList collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.DescribeTrailsRequest.TrailNameList"> <summary> The list of <a>Trail</a> object names. </summary> </member> <member name="T:Amazon.CloudTrail.Model.DescribeTrailsResponse"> <summary> Returns information about the DescribeTrailsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudTrail.Model.DescribeTrailsResponse.DescribeTrailsResult"> <summary> Gets and sets the DescribeTrailsResult property. Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.CloudTrail.Model.DescribeTrailsResult"> <summary> <para>Returns the objects or data listed below if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.CloudTrail.Model.DescribeTrailsResult.WithTrailList(Amazon.CloudTrail.Model.Trail[])"> <summary> Adds elements to the TrailList collection </summary> <param name="trailList">The values to add to the TrailList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.DescribeTrailsResult.WithTrailList(System.Collections.Generic.IEnumerable{Amazon.CloudTrail.Model.Trail})"> <summary> Adds elements to the TrailList collection </summary> <param name="trailList">The values to add to the TrailList collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.DescribeTrailsResult.TrailList"> <summary> An array of <a>Trail</a> objects. </summary> </member> <member name="T:Amazon.CloudTrail.Model.GetTrailStatusRequest"> <summary> Container for the parameters to the GetTrailStatus operation. <para>Returns a JSON-formatted list of information about the specified trail. Fields include information such as delivery errors, Amazon SNS and Amazon S3 errors, and times that logging started and stopped for each trail.</para> </summary> <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"/> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusRequest.Name"> <summary> The name of the trail for which you are requesting the current status. </summary> </member> <member name="T:Amazon.CloudTrail.Model.GetTrailStatusResponse"> <summary> Returns information about the GetTrailStatusResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResponse.GetTrailStatusResult"> <summary> Gets and sets the GetTrailStatusResult property. Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.CloudTrail.Model.GetTrailStatusResult"> <summary> <para>Returns the objects or data listed below if successful. Otherwise, returns an error.</para> </summary> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithIsLogging(System.Boolean)"> <summary> Sets the IsLogging property </summary> <param name="isLogging">The value to set for the IsLogging property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestDeliveryError(System.String)"> <summary> Sets the LatestDeliveryError property </summary> <param name="latestDeliveryError">The value to set for the LatestDeliveryError property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestNotificationError(System.String)"> <summary> Sets the LatestNotificationError property </summary> <param name="latestNotificationError">The value to set for the LatestNotificationError property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestDeliveryTime(System.DateTime)"> <summary> Sets the LatestDeliveryTime property </summary> <param name="latestDeliveryTime">The value to set for the LatestDeliveryTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestNotificationTime(System.DateTime)"> <summary> Sets the LatestNotificationTime property </summary> <param name="latestNotificationTime">The value to set for the LatestNotificationTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithStartLoggingTime(System.DateTime)"> <summary> Sets the StartLoggingTime property </summary> <param name="startLoggingTime">The value to set for the StartLoggingTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithStopLoggingTime(System.DateTime)"> <summary> Sets the StopLoggingTime property </summary> <param name="stopLoggingTime">The value to set for the StopLoggingTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestDeliveryAttemptTime(System.String)"> <summary> Sets the LatestDeliveryAttemptTime property </summary> <param name="latestDeliveryAttemptTime">The value to set for the LatestDeliveryAttemptTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestNotificationAttemptTime(System.String)"> <summary> Sets the LatestNotificationAttemptTime property </summary> <param name="latestNotificationAttemptTime">The value to set for the LatestNotificationAttemptTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestNotificationAttemptSucceeded(System.String)"> <summary> Sets the LatestNotificationAttemptSucceeded property </summary> <param name="latestNotificationAttemptSucceeded">The value to set for the LatestNotificationAttemptSucceeded property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithLatestDeliveryAttemptSucceeded(System.String)"> <summary> Sets the LatestDeliveryAttemptSucceeded property </summary> <param name="latestDeliveryAttemptSucceeded">The value to set for the LatestDeliveryAttemptSucceeded property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithTimeLoggingStarted(System.String)"> <summary> Sets the TimeLoggingStarted property </summary> <param name="timeLoggingStarted">The value to set for the TimeLoggingStarted property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.GetTrailStatusResult.WithTimeLoggingStopped(System.String)"> <summary> Sets the TimeLoggingStopped property </summary> <param name="timeLoggingStopped">The value to set for the TimeLoggingStopped property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.IsLogging"> <summary> Whether the CloudTrail is currently logging AWS API calls. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDeliveryError"> <summary> Information about the most recent error CloudTrail encountered when attempting to deliver log files to the account's Amazon S3 bucket. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestNotificationError"> <summary> Information about the most recent error CloudTrail encountered when attempting to send an Amazon SNS notification. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDeliveryAttemptTime"> <summary> The last time CloudTrail attempted to deliver a file to an account's Amazon S3 bucket. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestNotificationAttemptTime"> <summary> The last time CloudTrail attempted to notify an account's owner of a log delivery to the account's Amazon S3 bucket. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestNotificationAttemptSucceeded"> <summary> The last time CloudTrail successfully notified an account's owner of a log delivery to the account's Amazon S3 bucket. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDeliveryAttemptSucceeded"> <summary> The last time CloudTrail successfully delivered a log file to an account's Amazon S3 bucket. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.TimeLoggingStarted"> <summary> The time at which CloudTrail started logging AWS API calls for an account. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.TimeLoggingStopped"> <summary> The time at which CloudTrail stopped logging AWS API calls for an account. </summary> </member> <member name="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException.#ctor(System.String)"> <summary> Constructs a new InsufficientS3BucketPolicyException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException.#ctor(System.String)"> <summary> Constructs a new InsufficientSnsTopicPolicyException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InternalErrorException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InternalErrorException.#ctor(System.String)"> <summary> Constructs a new InternalErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.CreateTrailRequestMarshaller"> <summary> Create Trail Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.CreateTrailResponseUnmarshaller"> <summary> Response Unmarshaller for CreateTrail operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.CreateTrailResultUnmarshaller"> <summary> CreateTrailResultUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.DeleteTrailRequestMarshaller"> <summary> Delete Trail Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.DeleteTrailResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteTrail operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.DeleteTrailResultUnmarshaller"> <summary> DeleteTrailResultUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.DescribeTrailsRequestMarshaller"> <summary> Describe Trails Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.DescribeTrailsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTrails operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.DescribeTrailsResultUnmarshaller"> <summary> DescribeTrailsResultUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.GetTrailStatusRequestMarshaller"> <summary> Get Trail Status Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.GetTrailStatusResponseUnmarshaller"> <summary> Response Unmarshaller for GetTrailStatus operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.GetTrailStatusResultUnmarshaller"> <summary> GetTrailStatusResultUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.StartLoggingRequestMarshaller"> <summary> Start Logging Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.StartLoggingResponseUnmarshaller"> <summary> Response Unmarshaller for StartLogging operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.StartLoggingResultUnmarshaller"> <summary> StartLoggingResultUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.StopLoggingRequestMarshaller"> <summary> Stop Logging Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.StopLoggingResponseUnmarshaller"> <summary> Response Unmarshaller for StopLogging operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.StopLoggingResultUnmarshaller"> <summary> StopLoggingResultUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.TrailUnmarshaller"> <summary> TrailUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.UpdateTrailRequestMarshaller"> <summary> Update Trail Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.UpdateTrailResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateTrail operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.UpdateTrailResultUnmarshaller"> <summary> UpdateTrailResultUnmarshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidS3BucketNameException.#ctor(System.String)"> <summary> Constructs a new InvalidS3BucketNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidS3PrefixException.#ctor(System.String)"> <summary> Constructs a new InvalidS3PrefixException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidSnsTopicNameException.#ctor(System.String)"> <summary> Constructs a new InvalidSnsTopicNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidTrailNameException.#ctor(System.String)"> <summary> Constructs a new InvalidTrailNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException.#ctor(System.String)"> <summary> Constructs a new MaximumNumberOfTrailsExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.S3BucketDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new S3BucketDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.StartLoggingRequest"> <summary> Container for the parameters to the StartLogging operation. <para>Starts the recording of AWS API calls and log file delivery for a trail.</para> </summary> <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"/> </member> <member name="M:Amazon.CloudTrail.Model.StartLoggingRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.StartLoggingRequest.Name"> <summary> The name of the <a>Trail</a> for which CloudTrail logs AWS API calls. </summary> </member> <member name="T:Amazon.CloudTrail.Model.StartLoggingResponse"> <summary> Returns information about the StartLoggingResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudTrail.Model.StartLoggingResponse.StartLoggingResult"> <summary> Gets and sets the StartLoggingResult property. Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.CloudTrail.Model.StartLoggingResult"> <summary> <para>Returns the objects or data listed below if successful. Otherwise, returns an error.</para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.StopLoggingRequest"> <summary> Container for the parameters to the StopLogging operation. <para>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.</para> </summary> <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"/> </member> <member name="M:Amazon.CloudTrail.Model.StopLoggingRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.StopLoggingRequest.Name"> <summary> Communicates to CloudTrail the name of the <a>Trail</a> for which to stop logging AWS API calls. </summary> </member> <member name="T:Amazon.CloudTrail.Model.StopLoggingResponse"> <summary> Returns information about the StopLoggingResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudTrail.Model.StopLoggingResponse.StopLoggingResult"> <summary> Gets and sets the StopLoggingResult property. Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.CloudTrail.Model.StopLoggingResult"> <summary> <para>Returns the objects or data listed below if successful. Otherwise, returns an error.</para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.Trail"> <summary> <para> The settings for a trail. </para> </summary> </member> <member name="M:Amazon.CloudTrail.Model.Trail.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.Trail.WithS3BucketName(System.String)"> <summary> Sets the S3BucketName property </summary> <param name="s3BucketName">The value to set for the S3BucketName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.Trail.WithS3KeyPrefix(System.String)"> <summary> Sets the S3KeyPrefix property </summary> <param name="s3KeyPrefix">The value to set for the S3KeyPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.Trail.WithSnsTopicName(System.String)"> <summary> Sets the SnsTopicName property </summary> <param name="snsTopicName">The value to set for the SnsTopicName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.Trail.WithIncludeGlobalServiceEvents(System.Boolean)"> <summary> Sets the IncludeGlobalServiceEvents property </summary> <param name="includeGlobalServiceEvents">The value to set for the IncludeGlobalServiceEvents property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.Trail.Name"> <summary> Name of the trail defined when you call when you call <a>CreateTrail</a> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.S3BucketName"> <summary> Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. Passed when you call <a>CreateTrail</a>. </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.S3KeyPrefix"> <summary> Value of the Amazon S3 prefix </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.SnsTopicName"> <summary> Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.IncludeGlobalServiceEvents"> <summary> Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>. </summary> </member> <member name="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.TrailAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new TrailAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.TrailNotFoundException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.TrailNotFoundException.#ctor(System.String)"> <summary> Constructs a new TrailNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> <summary> AmazonCloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.TrailNotProvidedException.#ctor(System.String)"> <summary> Constructs a new TrailNotProvidedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.UpdateTrailRequest"> <summary> Container for the parameters to the UpdateTrail operation. <para>From the command line, use update-subscription.</para> <para>Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. You 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. Use a Trail data type to pass updated bucket or topic names.</para> </summary> <seealso cref="M:Amazon.CloudTrail.AmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"/> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailRequest.WithS3BucketName(System.String)"> <summary> Sets the S3BucketName property </summary> <param name="s3BucketName">The value to set for the S3BucketName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailRequest.WithS3KeyPrefix(System.String)"> <summary> Sets the S3KeyPrefix property </summary> <param name="s3KeyPrefix">The value to set for the S3KeyPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailRequest.WithSnsTopicName(System.String)"> <summary> Sets the SnsTopicName property </summary> <param name="snsTopicName">The value to set for the SnsTopicName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailRequest.WithIncludeGlobalServiceEvents(System.Boolean)"> <summary> Sets the IncludeGlobalServiceEvents property </summary> <param name="includeGlobalServiceEvents">The value to set for the IncludeGlobalServiceEvents property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailRequest.WithTrail(Amazon.CloudTrail.Model.Trail)"> <summary> Sets the Trail property </summary> <param name="trail">The value to set for the Trail property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.Trail"> <summary> Represents the <a>Trail</a> structure that contains the CloudTrail setting for an account. </summary> </member> <member name="T:Amazon.CloudTrail.Model.UpdateTrailResponse"> <summary> Returns information about the UpdateTrailResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResponse.UpdateTrailResult"> <summary> Gets and sets the UpdateTrailResult property. Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="T:Amazon.CloudTrail.Model.UpdateTrailResult"> <summary> <para> Returns the objects or data listed below if successful. Otherwise, returns an error. </para> </summary> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailResult.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailResult.WithS3BucketName(System.String)"> <summary> Sets the S3BucketName property </summary> <param name="s3BucketName">The value to set for the S3BucketName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailResult.WithS3KeyPrefix(System.String)"> <summary> Sets the S3KeyPrefix property </summary> <param name="s3KeyPrefix">The value to set for the S3KeyPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailResult.WithSnsTopicName(System.String)"> <summary> Sets the SnsTopicName property </summary> <param name="snsTopicName">The value to set for the SnsTopicName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailResult.WithIncludeGlobalServiceEvents(System.Boolean)"> <summary> Sets the IncludeGlobalServiceEvents property </summary> <param name="includeGlobalServiceEvents">The value to set for the IncludeGlobalServiceEvents property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudTrail.Model.UpdateTrailResult.WithTrail(Amazon.CloudTrail.Model.Trail)"> <summary> Sets the Trail property </summary> <param name="trail">The value to set for the Trail property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.Trail"> <summary> Represents the CloudTrail settings that were updated by calling <a>UpdateTrail</a>. </summary> </member> <member name="T:Amazon.CloudWatch.AmazonCloudWatch"> <summary> Interface for accessing AmazonCloudWatch. Amazon CloudWatch <para>This is the <i>Amazon CloudWatch API Reference</i> . This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide. </para> <para>Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch. </para> <para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the <i>Amazon CloudWatch Developer Guide</i> . </para> <para>Use the following links to get started using the <i>Amazon CloudWatch API Reference</i> :</para> <ul> <li> Actions: An alphabetical list of all Amazon CloudWatch actions.</li> <li> Data Types: An alphabetical list of all Amazon CloudWatch data types.</li> <li> Common Parameters: Parameters that all Query actions can use.</li> <li> Common Errors: Client and server errors that all actions can return.</li> <li> Regions and Endpoints: Itemized regions and endpoints for all AWS products.</li> <li> WSDL Location: http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl</li> </ul> </summary> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"> <summary> <para> 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> <para> When this operation creates an alarm, the alarm state is immediately set to <c>INSUFFICIENT_DATA</c> . The alarm is evaluated and its <c>StateValue</c> is set appropriately. Any actions associated with the <c>StateValue</c> is then executed. </para> <para><b>NOTE:</b> When updating an existing alarm, its StateValue is left unchanged. </para> </summary> <param name="putMetricAlarmRequest">Container for the necessary parameters to execute the PutMetricAlarm service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.LimitExceededException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginPutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricAlarm operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"/> </summary> <param name="putMetricAlarmRequest">Container for the necessary parameters to execute the PutMetricAlarm operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndPutMetricAlarm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricAlarm operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricAlarm.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"> <summary> <para> 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. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. </para> <para> The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests. </para> <para><b>IMPORTANT:</b> Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. </para> </summary> <param name="putMetricDataRequest">Container for the necessary parameters to execute the PutMetricData service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginPutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricData operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"/> </summary> <param name="putMetricDataRequest">Container for the necessary parameters to execute the PutMetricData operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndPutMetricData(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricData operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricData.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"> <summary> <para> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. </para> <para><b>NOTE:</b> Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. </para> </summary> <param name="listMetricsRequest">Container for the necessary parameters to execute the ListMetrics service method on AmazonCloudWatch.</param> <returns>The response from the ListMetrics service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMetrics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"/> </summary> <param name="listMetricsRequest">Container for the necessary parameters to execute the ListMetrics operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMetrics operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndListMetrics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListMetrics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMetrics.</param> <returns>Returns a ListMetricsResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.ListMetrics"> <summary> <para> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. </para> <para><b>NOTE:</b> Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. </para> </summary> <returns>The response from the ListMetrics service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"> <summary> <para> Gets statistics for the specified metric. </para> <para><b>NOTE:</b> The maximum number of data points returned from a single GetMetricStatistics request is 1,440. If a request is made that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, alter the request by narrowing the specified time range or increasing the specified period. Alternatively, make multiple requests across adjacent time ranges. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <c>period</c> 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><b>NOTE:</b> The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <c>GetMetricStatistics</c> 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 Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the <i>Amazon CloudWatch Developer Guide</i> . </para> </summary> <param name="getMetricStatisticsRequest">Container for the necessary parameters to execute the GetMetricStatistics service method on AmazonCloudWatch.</param> <returns>The response from the GetMetricStatistics service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginGetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetMetricStatistics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"/> </summary> <param name="getMetricStatisticsRequest">Container for the necessary parameters to execute the GetMetricStatistics operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetMetricStatistics operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndGetMetricStatistics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetMetricStatistics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetMetricStatistics.</param> <returns>Returns a GetMetricStatisticsResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"> <summary> <para> 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. </para> </summary> <param name="disableAlarmActionsRequest">Container for the necessary parameters to execute the DisableAlarmActions service method on AmazonCloudWatch.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginDisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"/> </summary> <param name="disableAlarmActionsRequest">Container for the necessary parameters to execute the DisableAlarmActions operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndDisableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableAlarmActions.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"> <summary> <para> 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. </para> </summary> <param name="describeAlarmsRequest">Container for the necessary parameters to execute the DescribeAlarms service method on AmazonCloudWatch.</param> <returns>The response from the DescribeAlarms service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginDescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"/> </summary> <param name="describeAlarmsRequest">Container for the necessary parameters to execute the DescribeAlarms operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarms operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndDescribeAlarms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarms.</param> <returns>Returns a DescribeAlarmsResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarms"> <summary> <para> 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. </para> </summary> <returns>The response from the DescribeAlarms service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"> <summary> <para> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </para> </summary> <param name="describeAlarmsForMetricRequest">Container for the necessary parameters to execute the DescribeAlarmsForMetric service method on AmazonCloudWatch.</param> <returns>The response from the DescribeAlarmsForMetric service method, as returned by AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginDescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmsForMetric operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"/> </summary> <param name="describeAlarmsForMetricRequest">Container for the necessary parameters to execute the DescribeAlarmsForMetric operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarmsForMetric operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndDescribeAlarmsForMetric(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarmsForMetric operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmsForMetric.</param> <returns>Returns a DescribeAlarmsForMetricResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"> <summary> <para> 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. </para> <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </para> </summary> <param name="describeAlarmHistoryRequest">Container for the necessary parameters to execute the DescribeAlarmHistory service method on AmazonCloudWatch.</param> <returns>The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginDescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmHistory operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"/> </summary> <param name="describeAlarmHistoryRequest">Container for the necessary parameters to execute the DescribeAlarmHistory operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarmHistory operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndDescribeAlarmHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarmHistory operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmHistory.</param> <returns>Returns a DescribeAlarmHistoryResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmHistory"> <summary> <para> 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. </para> <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </para> </summary> <returns>The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"> <summary> <para> Enables actions for the specified alarms. </para> </summary> <param name="enableAlarmActionsRequest">Container for the necessary parameters to execute the EnableAlarmActions service method on AmazonCloudWatch.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginEnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"/> </summary> <param name="enableAlarmActionsRequest">Container for the necessary parameters to execute the EnableAlarmActions operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndEnableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableAlarmActions.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"> <summary> <para> Deletes all specified alarms. In the event of an error, no alarms are deleted. </para> </summary> <param name="deleteAlarmsRequest">Container for the necessary parameters to execute the DeleteAlarms service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginDeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"/> </summary> <param name="deleteAlarmsRequest">Container for the necessary parameters to execute the DeleteAlarms operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndDeleteAlarms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAlarms.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"> <summary> <para> Temporarily sets the state of an alarm. When the updated <c>StateValue</c> differs from the previous value, the action configured for the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. </para> </summary> <param name="setAlarmStateRequest">Container for the necessary parameters to execute the SetAlarmState service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidFormatException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.BeginSetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetAlarmState operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"/> </summary> <param name="setAlarmStateRequest">Container for the necessary parameters to execute the SetAlarmState operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatch.EndSetAlarmState(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetAlarmState operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetAlarmState.</param> </member> <member name="T:Amazon.CloudWatch.AmazonCloudWatchClient"> <summary> Implementation for accessing AmazonCloudWatch. Amazon CloudWatch <para>This is the <i>Amazon CloudWatch API Reference</i> . This guide provides detailed information about Amazon CloudWatch actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch features and their associated API calls, go to the Amazon CloudWatch Developer Guide. </para> <para>Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics, as well as configure alarm actions based on data from metrics. For more information about this product go to http://aws.amazon.com/cloudwatch. </para> <para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to Cloudwatch, go to Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the <i>Amazon CloudWatch Developer Guide</i> . </para> <para>Use the following links to get started using the <i>Amazon CloudWatch API Reference</i> :</para> <ul> <li> Actions: An alphabetical list of all Amazon CloudWatch actions.</li> <li> Data Types: An alphabetical list of all Amazon CloudWatch data types.</li> <li> Common Parameters: Parameters that all Query actions can use.</li> <li> Common Errors: Client and server errors that all actions can return.</li> <li> Regions and Endpoints: Itemized regions and endpoints for all AWS products.</li> <li> WSDL Location: http://monitoring.amazonaws.com/doc/2010-08-01/CloudWatch.wsdl</li> </ul> </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudWatch 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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 AmazonCloudWatchConfig Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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 AmazonCloudWatchConfig Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"> <summary> <para> 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> <para> When this operation creates an alarm, the alarm state is immediately set to <c>INSUFFICIENT_DATA</c> . The alarm is evaluated and its <c>StateValue</c> is set appropriately. Any actions associated with the <c>StateValue</c> is then executed. </para> <para><b>NOTE:</b> When updating an existing alarm, its StateValue is left unchanged. </para> </summary> <param name="putMetricAlarmRequest">Container for the necessary parameters to execute the PutMetricAlarm service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.LimitExceededException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginPutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricAlarm operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"/> </summary> <param name="putMetricAlarmRequest">Container for the necessary parameters to execute the PutMetricAlarm operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndPutMetricAlarm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricAlarm operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricAlarm.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"> <summary> <para> 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. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. </para> <para> The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests. </para> <para><b>IMPORTANT:</b> Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. </para> </summary> <param name="putMetricDataRequest">Container for the necessary parameters to execute the PutMetricData service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginPutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricData operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"/> </summary> <param name="putMetricDataRequest">Container for the necessary parameters to execute the PutMetricData operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndPutMetricData(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricData operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricData.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"> <summary> <para> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. </para> <para><b>NOTE:</b> Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. </para> </summary> <param name="listMetricsRequest">Container for the necessary parameters to execute the ListMetrics service method on AmazonCloudWatch.</param> <returns>The response from the ListMetrics service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMetrics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"/> </summary> <param name="listMetricsRequest">Container for the necessary parameters to execute the ListMetrics operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMetrics operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndListMetrics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListMetrics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMetrics.</param> <returns>Returns a ListMetricsResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.ListMetrics"> <summary> <para> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. </para> <para><b>NOTE:</b> Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. </para> </summary> <returns>The response from the ListMetrics service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"> <summary> <para> Gets statistics for the specified metric. </para> <para><b>NOTE:</b> The maximum number of data points returned from a single GetMetricStatistics request is 1,440. If a request is made that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, alter the request by narrowing the specified time range or increasing the specified period. Alternatively, make multiple requests across adjacent time ranges. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <c>period</c> 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><b>NOTE:</b> The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <c>GetMetricStatistics</c> 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 Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the <i>Amazon CloudWatch Developer Guide</i> . </para> </summary> <param name="getMetricStatisticsRequest">Container for the necessary parameters to execute the GetMetricStatistics service method on AmazonCloudWatch.</param> <returns>The response from the GetMetricStatistics service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginGetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetMetricStatistics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"/> </summary> <param name="getMetricStatisticsRequest">Container for the necessary parameters to execute the GetMetricStatistics operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetMetricStatistics operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndGetMetricStatistics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetMetricStatistics operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetMetricStatistics.</param> <returns>Returns a GetMetricStatisticsResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"> <summary> <para> 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. </para> </summary> <param name="disableAlarmActionsRequest">Container for the necessary parameters to execute the DisableAlarmActions service method on AmazonCloudWatch.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"/> </summary> <param name="disableAlarmActionsRequest">Container for the necessary parameters to execute the DisableAlarmActions operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndDisableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableAlarmActions.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"> <summary> <para> 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. </para> </summary> <param name="describeAlarmsRequest">Container for the necessary parameters to execute the DescribeAlarms service method on AmazonCloudWatch.</param> <returns>The response from the DescribeAlarms service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"/> </summary> <param name="describeAlarmsRequest">Container for the necessary parameters to execute the DescribeAlarms operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarms operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndDescribeAlarms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarms.</param> <returns>Returns a DescribeAlarmsResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarms"> <summary> <para> 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. </para> </summary> <returns>The response from the DescribeAlarms service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"> <summary> <para> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </para> </summary> <param name="describeAlarmsForMetricRequest">Container for the necessary parameters to execute the DescribeAlarmsForMetric service method on AmazonCloudWatch.</param> <returns>The response from the DescribeAlarmsForMetric service method, as returned by AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmsForMetric operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"/> </summary> <param name="describeAlarmsForMetricRequest">Container for the necessary parameters to execute the DescribeAlarmsForMetric operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarmsForMetric operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndDescribeAlarmsForMetric(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarmsForMetric operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmsForMetric.</param> <returns>Returns a DescribeAlarmsForMetricResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"> <summary> <para> 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. </para> <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </para> </summary> <param name="describeAlarmHistoryRequest">Container for the necessary parameters to execute the DescribeAlarmHistory service method on AmazonCloudWatch.</param> <returns>The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmHistory operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"/> </summary> <param name="describeAlarmHistoryRequest">Container for the necessary parameters to execute the DescribeAlarmHistory operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAlarmHistory operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndDescribeAlarmHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarmHistory operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmHistory.</param> <returns>Returns a DescribeAlarmHistoryResult from AmazonCloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmHistory"> <summary> <para> 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. </para> <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </para> </summary> <returns>The response from the DescribeAlarmHistory service method, as returned by AmazonCloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"> <summary> <para> Enables actions for the specified alarms. </para> </summary> <param name="enableAlarmActionsRequest">Container for the necessary parameters to execute the EnableAlarmActions service method on AmazonCloudWatch.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginEnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"/> </summary> <param name="enableAlarmActionsRequest">Container for the necessary parameters to execute the EnableAlarmActions operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndEnableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableAlarmActions operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableAlarmActions.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"> <summary> <para> Deletes all specified alarms. In the event of an error, no alarms are deleted. </para> </summary> <param name="deleteAlarmsRequest">Container for the necessary parameters to execute the DeleteAlarms service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"/> </summary> <param name="deleteAlarmsRequest">Container for the necessary parameters to execute the DeleteAlarms operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndDeleteAlarms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAlarms operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAlarms.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"> <summary> <para> Temporarily sets the state of an alarm. When the updated <c>StateValue</c> differs from the previous value, the action configured for the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. </para> </summary> <param name="setAlarmStateRequest">Container for the necessary parameters to execute the SetAlarmState service method on AmazonCloudWatch.</param> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.CloudWatch.Model.InvalidFormatException"/> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginSetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetAlarmState operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"/> </summary> <param name="setAlarmStateRequest">Container for the necessary parameters to execute the SetAlarmState operation on AmazonCloudWatch.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndSetAlarmState(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetAlarmState operation. <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetAlarmState.</param> </member> <member name="T:Amazon.CloudWatch.AmazonCloudWatchConfig"> <summary> Configuration for accessing Amazon CloudWatch service </summary> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudWatch.AmazonCloudWatchConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudWatch.AmazonCloudWatchConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CloudWatch.Model.AlarmHistoryItem"> <summary> <para> The <c>AlarmHistoryItem</c> data type contains descriptive information about the history of a specific alarm. If you call DescribeAlarmHistory, Amazon CloudWatch returns this data type as part of the DescribeAlarmHistoryResult data type. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.AlarmHistoryItem.WithAlarmName(System.String)"> <summary> Sets the AlarmName property </summary> <param name="alarmName">The value to set for the AlarmName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.AlarmHistoryItem.WithTimestamp(System.DateTime)"> <summary> Sets the Timestamp property </summary> <param name="timestamp">The value to set for the Timestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.AlarmHistoryItem.WithHistoryItemType(System.String)"> <summary> Sets the HistoryItemType property </summary> <param name="historyItemType">The value to set for the HistoryItemType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.AlarmHistoryItem.WithHistorySummary(System.String)"> <summary> Sets the HistorySummary property </summary> <param name="historySummary">The value to set for the HistorySummary property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.AlarmHistoryItem.WithHistoryData(System.String)"> <summary> Sets the HistoryData property </summary> <param name="historyData">The value to set for the HistoryData property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.AlarmName"> <summary> The descriptive name for the alarm. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.Timestamp"> <summary> The time stamp for the alarm history item. </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.HistoryItemType"> <summary> The type of alarm history item. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ConfigurationUpdate, StateUpdate, Action</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.HistorySummary"> <summary> A human-readable summary of the alarm history. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.HistoryData"> <summary> Machine-readable data about the alarm in JSON format. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 4095</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.Datapoint"> <summary> <para> The <c>Datapoint</c> data type encapsulates the statistical data that Amazon CloudWatch computes from metric data. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.Datapoint.WithTimestamp(System.DateTime)"> <summary> Sets the Timestamp property </summary> <param name="timestamp">The value to set for the Timestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Datapoint.WithSampleCount(System.Double)"> <summary> Sets the SampleCount property </summary> <param name="sampleCount">The value to set for the SampleCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Datapoint.WithAverage(System.Double)"> <summary> Sets the Average property </summary> <param name="average">The value to set for the Average property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Datapoint.WithSum(System.Double)"> <summary> Sets the Sum property </summary> <param name="sum">The value to set for the Sum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Datapoint.WithMinimum(System.Double)"> <summary> Sets the Minimum property </summary> <param name="minimum">The value to set for the Minimum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Datapoint.WithMaximum(System.Double)"> <summary> Sets the Maximum property </summary> <param name="maximum">The value to set for the Maximum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Datapoint.WithUnit(System.String)"> <summary> Sets the Unit property </summary> <param name="unit">The value to set for the Unit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Timestamp"> <summary> The time stamp used for the datapoint. </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.SampleCount"> <summary> The number of metric values that contributed to the aggregate value of this datapoint. </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Average"> <summary> The average of metric values that correspond to the datapoint. </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Sum"> <summary> The sum of metric values used for the datapoint. </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Minimum"> <summary> The minimum metric value used for the datapoint. </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Maximum"> <summary> The maximum of the metric value used for the datapoint. </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Unit"> <summary> The standard unit used for the datapoint. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DeleteAlarmsRequest"> <summary> Container for the parameters to the DeleteAlarms operation. <para> Deletes all specified alarms. In the event of an error, no alarms are deleted. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.DeleteAlarmsRequest.WithAlarmNames(System.String[])"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DeleteAlarmsRequest.WithAlarmNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DeleteAlarmsRequest.AlarmNames"> <summary> A list of alarms to be deleted. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DeleteAlarmsResponse"> <summary> Returns information about the DeleteAlarms response metadata. The DeleteAlarms operation has a void result type. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest"> <summary> Container for the parameters to the DescribeAlarmHistory operation. <para> 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. </para> <para><b>NOTE:</b> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.WithAlarmName(System.String)"> <summary> Sets the AlarmName property </summary> <param name="alarmName">The value to set for the AlarmName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.WithHistoryItemType(System.String)"> <summary> Sets the HistoryItemType property </summary> <param name="historyItemType">The value to set for the HistoryItemType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.WithStartDate(System.DateTime)"> <summary> Sets the StartDate property </summary> <param name="startDate">The value to set for the StartDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.WithEndDate(System.DateTime)"> <summary> Sets the EndDate property </summary> <param name="endDate">The value to set for the EndDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.AlarmName"> <summary> The name of the alarm. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.HistoryItemType"> <summary> The type of alarm histories to retrieve. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ConfigurationUpdate, StateUpdate, Action</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.StartDate"> <summary> The starting date to retrieve alarm history. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.EndDate"> <summary> The ending date to retrieve alarm history. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.MaxRecords"> <summary> The maximum number of alarm history records to retrieve. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.NextToken"> <summary> The token returned by a previous call to indicate that there is more data available. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse"> <summary> Returns information about the DescribeAlarmHistoryResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse.DescribeAlarmHistoryResult"> <summary> Gets and sets the DescribeAlarmHistoryResult property. The output for the DescribeAlarmHistory action. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult"> <summary> <para> The output for the DescribeAlarmHistory action. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult.WithAlarmHistoryItems(Amazon.CloudWatch.Model.AlarmHistoryItem[])"> <summary> Adds elements to the AlarmHistoryItems collection </summary> <param name="alarmHistoryItems">The values to add to the AlarmHistoryItems collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult.WithAlarmHistoryItems(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.AlarmHistoryItem})"> <summary> Adds elements to the AlarmHistoryItems collection </summary> <param name="alarmHistoryItems">The values to add to the AlarmHistoryItems collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult.AlarmHistoryItems"> <summary> A list of alarm histories in JSON format. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult.NextToken"> <summary> A string that marks the start of the next batch of returned results. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest"> <summary> Container for the parameters to the DescribeAlarmsForMetric operation. <para> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.WithMetricName(System.String)"> <summary> Sets the MetricName property </summary> <param name="metricName">The value to set for the MetricName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="namespaceValue">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.WithStatistic(System.String)"> <summary> Sets the Statistic property </summary> <param name="statistic">The value to set for the Statistic property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.WithDimensions(Amazon.CloudWatch.Model.Dimension[])"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.WithDimensions(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Dimension})"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.WithPeriod(System.Int32)"> <summary> Sets the Period property </summary> <param name="period">The value to set for the Period property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.WithUnit(System.String)"> <summary> Sets the Unit property </summary> <param name="unit">The value to set for the Unit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.MetricName"> <summary> The name of the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Namespace"> <summary> The namespace of the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> <item> <term>Pattern</term> <description>[^:].*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Statistic"> <summary> The statistic for the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>SampleCount, Average, Sum, Minimum, Maximum</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Dimensions"> <summary> The list of dimensions associated with the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Period"> <summary> The period in seconds over which the statistic is applied. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>60 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Unit"> <summary> The unit for the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResponse"> <summary> Returns information about the DescribeAlarmsForMetricResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResponse.DescribeAlarmsForMetricResult"> <summary> Gets and sets the DescribeAlarmsForMetricResult property. The output for the DescribeAlarmsForMetric action. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResult"> <summary> <para> The output for the DescribeAlarmsForMetric action. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResult.WithMetricAlarms(Amazon.CloudWatch.Model.MetricAlarm[])"> <summary> Adds elements to the MetricAlarms collection </summary> <param name="metricAlarms">The values to add to the MetricAlarms collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResult.WithMetricAlarms(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.MetricAlarm})"> <summary> Adds elements to the MetricAlarms collection </summary> <param name="metricAlarms">The values to add to the MetricAlarms collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResult.MetricAlarms"> <summary> A list of information for each alarm with the specified metric. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsRequest"> <summary> Container for the parameters to the DescribeAlarms operation. <para> 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. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsRequest.WithAlarmNames(System.String[])"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsRequest.WithAlarmNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsRequest.WithAlarmNamePrefix(System.String)"> <summary> Sets the AlarmNamePrefix property </summary> <param name="alarmNamePrefix">The value to set for the AlarmNamePrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsRequest.WithStateValue(System.String)"> <summary> Sets the StateValue property </summary> <param name="stateValue">The value to set for the StateValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsRequest.WithActionPrefix(System.String)"> <summary> Sets the ActionPrefix property </summary> <param name="actionPrefix">The value to set for the ActionPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.AlarmNames"> <summary> A list of alarm names to retrieve information for. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.AlarmNamePrefix"> <summary> The alarm name prefix. <c>AlarmNames</c> cannot be specified if this parameter is specified. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.StateValue"> <summary> The state value to be used in matching alarms. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>OK, ALARM, INSUFFICIENT_DATA</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.ActionPrefix"> <summary> The action name prefix. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.MaxRecords"> <summary> The maximum number of alarm descriptions to retrieve. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.NextToken"> <summary> The token returned by a previous call to indicate that there is more data available. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsResponse"> <summary> Returns information about the DescribeAlarmsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsResponse.DescribeAlarmsResult"> <summary> Gets and sets the DescribeAlarmsResult property. The output for the DescribeAlarms action. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsResult"> <summary> <para> The output for the DescribeAlarms action. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsResult.WithMetricAlarms(Amazon.CloudWatch.Model.MetricAlarm[])"> <summary> Adds elements to the MetricAlarms collection </summary> <param name="metricAlarms">The values to add to the MetricAlarms collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsResult.WithMetricAlarms(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.MetricAlarm})"> <summary> Adds elements to the MetricAlarms collection </summary> <param name="metricAlarms">The values to add to the MetricAlarms collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DescribeAlarmsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsResult.MetricAlarms"> <summary> A list of information for the specified alarms. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsResult.NextToken"> <summary> A string that marks the start of the next batch of returned results. </summary> </member> <member name="T:Amazon.CloudWatch.Model.Dimension"> <summary> <para> The <c>Dimension</c> data type further expands on the identity of a metric using a Name, Value pair. </para> <para>For examples that use one or more dimensions, see PutMetricData.</para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.Dimension.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Dimension.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.Dimension.Name"> <summary> The name of the dimension. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Dimension.Value"> <summary> The value representing the dimension measurement <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DimensionFilter"> <summary> <para> The <c>DimensionFilter</c> data type is used to filter ListMetrics results. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.DimensionFilter.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DimensionFilter.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DimensionFilter.Name"> <summary> The dimension name to be matched. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DimensionFilter.Value"> <summary> The value of the dimension to be matched. <note> Specifying a <c>Name</c> without specifying a <c>Value</c> returns all values associated with that <c>Name</c>. </note> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DisableAlarmActionsRequest"> <summary> Container for the parameters to the DisableAlarmActions operation. <para> 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. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.DisableAlarmActionsRequest.WithAlarmNames(System.String[])"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.DisableAlarmActionsRequest.WithAlarmNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.DisableAlarmActionsRequest.AlarmNames"> <summary> The names of the alarms to disable actions for. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DisableAlarmActionsResponse"> <summary> Returns information about the DisableAlarmActions response metadata. The DisableAlarmActions operation has a void result type. </summary> </member> <member name="T:Amazon.CloudWatch.Model.EnableAlarmActionsRequest"> <summary> Container for the parameters to the EnableAlarmActions operation. <para> Enables actions for the specified alarms. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.EnableAlarmActionsRequest.WithAlarmNames(System.String[])"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.EnableAlarmActionsRequest.WithAlarmNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AlarmNames collection </summary> <param name="alarmNames">The values to add to the AlarmNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.EnableAlarmActionsRequest.AlarmNames"> <summary> The names of the alarms to enable actions for. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.EnableAlarmActionsResponse"> <summary> Returns information about the EnableAlarmActions response metadata. The EnableAlarmActions operation has a void result type. </summary> </member> <member name="T:Amazon.CloudWatch.Model.GetMetricStatisticsRequest"> <summary> Container for the parameters to the GetMetricStatistics operation. <para> Gets statistics for the specified metric. </para> <para><b>NOTE:</b> The maximum number of data points returned from a single GetMetricStatistics request is 1,440. If a request is made that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, alter the request by narrowing the specified time range or increasing the specified period. Alternatively, make multiple requests across adjacent time ranges. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <c>period</c> 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><b>NOTE:</b> The maximum number of data points that can be queried is 50,850; whereas the maximum number of data points returned is 1,440. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <c>GetMetricStatistics</c> 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 Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference in the <i>Amazon CloudWatch Developer Guide</i> . </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="namespaceValue">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithMetricName(System.String)"> <summary> Sets the MetricName property </summary> <param name="metricName">The value to set for the MetricName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithDimensions(Amazon.CloudWatch.Model.Dimension[])"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithDimensions(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Dimension})"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithEndTime(System.DateTime)"> <summary> Sets the EndTime property </summary> <param name="endTime">The value to set for the EndTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithPeriod(System.Int32)"> <summary> Sets the Period property </summary> <param name="period">The value to set for the Period property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithStatistics(System.String[])"> <summary> Adds elements to the Statistics collection </summary> <param name="statistics">The values to add to the Statistics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithStatistics(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Statistics collection </summary> <param name="statistics">The values to add to the Statistics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.WithUnit(System.String)"> <summary> Sets the Unit property </summary> <param name="unit">The value to set for the Unit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Namespace"> <summary> The namespace of the metric, with or without spaces. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> <item> <term>Pattern</term> <description>[^:].*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.MetricName"> <summary> The name of the metric, with or without spaces. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Dimensions"> <summary> A list of dimensions describing qualities of the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.StartTime"> <summary> The time stamp to use for determining the first datapoint to return. The value specified is inclusive; results include datapoints with the time stamp specified. <note> The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks. </note> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.EndTime"> <summary> The time stamp to use for determining the last datapoint to return. The value specified is exclusive; results will include datapoints up to the time stamp specified. </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Period"> <summary> The granularity, in seconds, of the returned datapoints. <c>Period</c> must be at least 60 seconds and must be a multiple of 60. The default value is 60. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>60 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Statistics"> <summary> The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, go to <a href="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/index.html?CHAP_TerminologyandKeyConcepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch Developer Guide</i>. Valid Values: <c>Average | Sum | SampleCount | Maximum | Minimum</c> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Unit"> <summary> The unit for the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.GetMetricStatisticsResponse"> <summary> Returns information about the GetMetricStatisticsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsResponse.GetMetricStatisticsResult"> <summary> Gets and sets the GetMetricStatisticsResult property. The output for the GetMetricStatistics action. </summary> </member> <member name="T:Amazon.CloudWatch.Model.GetMetricStatisticsResult"> <summary> <para> The output for the GetMetricStatistics action. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsResult.WithLabel(System.String)"> <summary> Sets the Label property </summary> <param name="label">The value to set for the Label property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsResult.WithDatapoints(Amazon.CloudWatch.Model.Datapoint[])"> <summary> Adds elements to the Datapoints collection </summary> <param name="datapoints">The values to add to the Datapoints collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.GetMetricStatisticsResult.WithDatapoints(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Datapoint})"> <summary> Adds elements to the Datapoints collection </summary> <param name="datapoints">The values to add to the Datapoints collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsResult.Label"> <summary> A label describing the specified metric. </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsResult.Datapoints"> <summary> The datapoints for the specified metric. </summary> </member> <member name="T:Amazon.CloudWatch.Model.InternalServiceException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.InternalServiceException.#ctor(System.String)"> <summary> Constructs a new InternalServiceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.AlarmHistoryItemUnmarshaller"> <summary> AlarmHistoryItem Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DatapointUnmarshaller"> <summary> Datapoint Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DeleteAlarmsRequestMarshaller"> <summary> Delete Alarms Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DeleteAlarmsResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteAlarms operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmHistoryRequestMarshaller"> <summary> Describe Alarm History Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmHistoryResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAlarmHistory operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmHistoryResultUnmarshaller"> <summary> DescribeAlarmHistoryResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmsForMetricRequestMarshaller"> <summary> Describe Alarms For Metric Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmsForMetricResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAlarmsForMetric operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmsForMetricResultUnmarshaller"> <summary> DescribeAlarmsForMetricResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmsRequestMarshaller"> <summary> Describe Alarms Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAlarms operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DescribeAlarmsResultUnmarshaller"> <summary> DescribeAlarmsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DimensionUnmarshaller"> <summary> Dimension Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DisableAlarmActionsRequestMarshaller"> <summary> Disable Alarm Actions Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DisableAlarmActionsResponseUnmarshaller"> <summary> Response Unmarshaller for DisableAlarmActions operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.EnableAlarmActionsRequestMarshaller"> <summary> Enable Alarm Actions Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.EnableAlarmActionsResponseUnmarshaller"> <summary> Response Unmarshaller for EnableAlarmActions operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.GetMetricStatisticsRequestMarshaller"> <summary> Get Metric Statistics Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.GetMetricStatisticsResponseUnmarshaller"> <summary> Response Unmarshaller for GetMetricStatistics operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.GetMetricStatisticsResultUnmarshaller"> <summary> GetMetricStatisticsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.ListMetricsRequestMarshaller"> <summary> List Metrics Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.ListMetricsResponseUnmarshaller"> <summary> Response Unmarshaller for ListMetrics operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.ListMetricsResultUnmarshaller"> <summary> ListMetricsResult Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.MetricAlarmUnmarshaller"> <summary> MetricAlarm Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.MetricUnmarshaller"> <summary> Metric Unmarshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.PutMetricAlarmRequestMarshaller"> <summary> Put Metric Alarm Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.PutMetricAlarmResponseUnmarshaller"> <summary> Response Unmarshaller for PutMetricAlarm operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.PutMetricDataRequestMarshaller"> <summary> Put Metric Data Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.PutMetricDataResponseUnmarshaller"> <summary> Response Unmarshaller for PutMetricData operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.SetAlarmStateRequestMarshaller"> <summary> Set Alarm State Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.SetAlarmStateResponseUnmarshaller"> <summary> Response Unmarshaller for SetAlarmState operation </summary> </member> <member name="T:Amazon.CloudWatch.Model.InvalidFormatException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.InvalidFormatException.#ctor(System.String)"> <summary> Constructs a new InvalidFormatException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.InvalidNextTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidNextTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.InvalidParameterCombinationException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterCombinationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.InvalidParameterValueException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterValueException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.LimitExceededException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.ListMetricsRequest"> <summary> Container for the parameters to the ListMetrics operation. <para> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with GetMetricStatistics to obtain statistical data for a given metric. </para> <para><b>NOTE:</b> Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken values with subsequent ListMetrics operations. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. Statistics about the metric, however, are available sooner using GetMetricStatistics. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsRequest.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="namespaceValue">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsRequest.WithMetricName(System.String)"> <summary> Sets the MetricName property </summary> <param name="metricName">The value to set for the MetricName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsRequest.WithDimensions(Amazon.CloudWatch.Model.DimensionFilter[])"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsRequest.WithDimensions(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.DimensionFilter})"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.Namespace"> <summary> The namespace to filter against. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> <item> <term>Pattern</term> <description>[^:].*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.MetricName"> <summary> The name of the metric to filter against. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.Dimensions"> <summary> A list of dimensions to filter against. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.NextToken"> <summary> The token returned by a previous call to indicate that there is more data available. </summary> </member> <member name="T:Amazon.CloudWatch.Model.ListMetricsResponse"> <summary> Returns information about the ListMetricsResult response and response metadata. </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsResponse.ListMetricsResult"> <summary> Gets and sets the ListMetricsResult property. The output for the ListMetrics action. </summary> </member> <member name="T:Amazon.CloudWatch.Model.ListMetricsResult"> <summary> <para> The output for the ListMetrics action. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsResult.WithMetrics(Amazon.CloudWatch.Model.Metric[])"> <summary> Adds elements to the Metrics collection </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsResult.WithMetrics(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Metric})"> <summary> Adds elements to the Metrics collection </summary> <param name="metrics">The values to add to the Metrics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.ListMetricsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsResult.Metrics"> <summary> A list of metrics used to generate statistics for an AWS account. </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsResult.NextToken"> <summary> A string that marks the start of the next batch of returned results. </summary> </member> <member name="T:Amazon.CloudWatch.Model.Metric"> <summary> <para> The <c>Metric</c> data type contains information about a specific metric. If you call ListMetrics, Amazon CloudWatch returns information contained by this data type. </para> <para> The example in the Examples section publishes two metrics named buffers and latency. Both metrics are in the examples namespace. Both metrics have two dimensions, InstanceID and InstanceType. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.Metric.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="namespaceValue">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Metric.WithMetricName(System.String)"> <summary> Sets the MetricName property </summary> <param name="metricName">The value to set for the MetricName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Metric.WithDimensions(Amazon.CloudWatch.Model.Dimension[])"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.Metric.WithDimensions(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Dimension})"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.Metric.Namespace"> <summary> The namespace of the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> <item> <term>Pattern</term> <description>[^:].*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Metric.MetricName"> <summary> The name of the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Metric.Dimensions"> <summary> A list of dimensions associated with the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.MetricAlarm"> <summary> <para> The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithAlarmName(System.String)"> <summary> Sets the AlarmName property </summary> <param name="alarmName">The value to set for the AlarmName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithAlarmArn(System.String)"> <summary> Sets the AlarmArn property </summary> <param name="alarmArn">The value to set for the AlarmArn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithAlarmDescription(System.String)"> <summary> Sets the AlarmDescription property </summary> <param name="alarmDescription">The value to set for the AlarmDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithAlarmConfigurationUpdatedTimestamp(System.DateTime)"> <summary> Sets the AlarmConfigurationUpdatedTimestamp property </summary> <param name="alarmConfigurationUpdatedTimestamp">The value to set for the AlarmConfigurationUpdatedTimestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithActionsEnabled(System.Boolean)"> <summary> Sets the ActionsEnabled property </summary> <param name="actionsEnabled">The value to set for the ActionsEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithOKActions(System.String[])"> <summary> Adds elements to the OKActions collection </summary> <param name="oKActions">The values to add to the OKActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithOKActions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the OKActions collection </summary> <param name="oKActions">The values to add to the OKActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithAlarmActions(System.String[])"> <summary> Adds elements to the AlarmActions collection </summary> <param name="alarmActions">The values to add to the AlarmActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithAlarmActions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AlarmActions collection </summary> <param name="alarmActions">The values to add to the AlarmActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithInsufficientDataActions(System.String[])"> <summary> Adds elements to the InsufficientDataActions collection </summary> <param name="insufficientDataActions">The values to add to the InsufficientDataActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithInsufficientDataActions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the InsufficientDataActions collection </summary> <param name="insufficientDataActions">The values to add to the InsufficientDataActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithStateValue(System.String)"> <summary> Sets the StateValue property </summary> <param name="stateValue">The value to set for the StateValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithStateReason(System.String)"> <summary> Sets the StateReason property </summary> <param name="stateReason">The value to set for the StateReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithStateReasonData(System.String)"> <summary> Sets the StateReasonData property </summary> <param name="stateReasonData">The value to set for the StateReasonData property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithStateUpdatedTimestamp(System.DateTime)"> <summary> Sets the StateUpdatedTimestamp property </summary> <param name="stateUpdatedTimestamp">The value to set for the StateUpdatedTimestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithMetricName(System.String)"> <summary> Sets the MetricName property </summary> <param name="metricName">The value to set for the MetricName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="namespaceValue">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithStatistic(System.String)"> <summary> Sets the Statistic property </summary> <param name="statistic">The value to set for the Statistic property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithDimensions(Amazon.CloudWatch.Model.Dimension[])"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithDimensions(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Dimension})"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithPeriod(System.Int32)"> <summary> Sets the Period property </summary> <param name="period">The value to set for the Period property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithUnit(System.String)"> <summary> Sets the Unit property </summary> <param name="unit">The value to set for the Unit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithEvaluationPeriods(System.Int32)"> <summary> Sets the EvaluationPeriods property </summary> <param name="evaluationPeriods">The value to set for the EvaluationPeriods property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithThreshold(System.Double)"> <summary> Sets the Threshold property </summary> <param name="threshold">The value to set for the Threshold property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricAlarm.WithComparisonOperator(System.String)"> <summary> Sets the ComparisonOperator property </summary> <param name="comparisonOperator">The value to set for the ComparisonOperator property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmName"> <summary> The name of the alarm. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmArn"> <summary> The Amazon Resource Name (ARN) of the alarm. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1600</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmDescription"> <summary> The description for the alarm. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmConfigurationUpdatedTimestamp"> <summary> The time stamp of the last update to the alarm configuration. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.ActionsEnabled"> <summary> Indicates whether actions should be executed during any changes to the alarm's state. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.OKActions"> <summary> The list of actions to execute when this alarm transitions into an <c>OK</c> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmActions"> <summary> The list of actions to execute when this alarm transitions into an <c>ALARM</c> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.InsufficientDataActions"> <summary> The list of actions to execute when this alarm transitions into an <c>INSUFFICIENT_DATA</c> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy. <important>The current WSDL lists this attribute as <c>UnknownActions</c>.</important> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateValue"> <summary> The state value for the alarm. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>OK, ALARM, INSUFFICIENT_DATA</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateReason"> <summary> A human-readable explanation for the alarm's state. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1023</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateReasonData"> <summary> An explanation for the alarm's state in machine-readable JSON format <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 4000</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateUpdatedTimestamp"> <summary> The time stamp of the last update to the alarm's state. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.MetricName"> <summary> The name of the alarm's metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Namespace"> <summary> The namespace of alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> <item> <term>Pattern</term> <description>[^:].*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Statistic"> <summary> The statistic to apply to the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>SampleCount, Average, Sum, Minimum, Maximum</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Dimensions"> <summary> The list of dimensions associated with the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Period"> <summary> The period in seconds over which the statistic is applied. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>60 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Unit"> <summary> The unit of the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.EvaluationPeriods"> <summary> The number of periods over which data is compared to the specified threshold. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Threshold"> <summary> The value against which the specified statistic is compared. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.ComparisonOperator"> <summary> The arithmetic operation to use when comparing the specified <c>Statistic</c> and <c>Threshold</c>. The specified <c>Statistic</c> value is used as the first operand. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.MetricDatum"> <summary> <para> The <c>MetricDatum</c> data type encapsulates the information sent with PutMetricData to either create a new metric or add new values to be aggregated into an existing metric. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.MetricDatum.WithMetricName(System.String)"> <summary> Sets the MetricName property </summary> <param name="metricName">The value to set for the MetricName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricDatum.WithDimensions(Amazon.CloudWatch.Model.Dimension[])"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricDatum.WithDimensions(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Dimension})"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricDatum.WithTimestamp(System.DateTime)"> <summary> Sets the Timestamp property </summary> <param name="timestamp">The value to set for the Timestamp property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricDatum.WithValue(System.Double)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricDatum.WithStatisticValues(Amazon.CloudWatch.Model.StatisticSet)"> <summary> Sets the StatisticValues property </summary> <param name="statisticValues">The value to set for the StatisticValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.MetricDatum.WithUnit(System.String)"> <summary> Sets the Unit property </summary> <param name="unit">The value to set for the Unit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.MetricName"> <summary> The name of the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Dimensions"> <summary> A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Timestamp"> <summary> The time stamp used for the metric. If not specified, the default value is set to the time the metric data was received. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Value"> <summary> The value for the metric. <important>Although the <c>Value</c> parameter accepts numbers of type <c>Double</c>, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. </important> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.StatisticValues"> <summary> A set of statistical values describing the metric. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Unit"> <summary> The unit of the metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.MissingRequiredParameterException.#ctor(System.String)"> <summary> Constructs a new MissingRequiredParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.PutMetricAlarmRequest"> <summary> Container for the parameters to the PutMetricAlarm operation. <para> 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> <para> When this operation creates an alarm, the alarm state is immediately set to <c>INSUFFICIENT_DATA</c> . The alarm is evaluated and its <c>StateValue</c> is set appropriately. Any actions associated with the <c>StateValue</c> is then executed. </para> <para><b>NOTE:</b> When updating an existing alarm, its StateValue is left unchanged. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithAlarmName(System.String)"> <summary> Sets the AlarmName property </summary> <param name="alarmName">The value to set for the AlarmName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithAlarmDescription(System.String)"> <summary> Sets the AlarmDescription property </summary> <param name="alarmDescription">The value to set for the AlarmDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithActionsEnabled(System.Boolean)"> <summary> Sets the ActionsEnabled property </summary> <param name="actionsEnabled">The value to set for the ActionsEnabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithOKActions(System.String[])"> <summary> Adds elements to the OKActions collection </summary> <param name="oKActions">The values to add to the OKActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithOKActions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the OKActions collection </summary> <param name="oKActions">The values to add to the OKActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithAlarmActions(System.String[])"> <summary> Adds elements to the AlarmActions collection </summary> <param name="alarmActions">The values to add to the AlarmActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithAlarmActions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AlarmActions collection </summary> <param name="alarmActions">The values to add to the AlarmActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithInsufficientDataActions(System.String[])"> <summary> Adds elements to the InsufficientDataActions collection </summary> <param name="insufficientDataActions">The values to add to the InsufficientDataActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithInsufficientDataActions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the InsufficientDataActions collection </summary> <param name="insufficientDataActions">The values to add to the InsufficientDataActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithMetricName(System.String)"> <summary> Sets the MetricName property </summary> <param name="metricName">The value to set for the MetricName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="namespaceValue">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithStatistic(System.String)"> <summary> Sets the Statistic property </summary> <param name="statistic">The value to set for the Statistic property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithDimensions(Amazon.CloudWatch.Model.Dimension[])"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithDimensions(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.Dimension})"> <summary> Adds elements to the Dimensions collection </summary> <param name="dimensions">The values to add to the Dimensions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithPeriod(System.Int32)"> <summary> Sets the Period property </summary> <param name="period">The value to set for the Period property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithUnit(System.String)"> <summary> Sets the Unit property </summary> <param name="unit">The value to set for the Unit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithEvaluationPeriods(System.Int32)"> <summary> Sets the EvaluationPeriods property </summary> <param name="evaluationPeriods">The value to set for the EvaluationPeriods property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithThreshold(System.Double)"> <summary> Sets the Threshold property </summary> <param name="threshold">The value to set for the Threshold property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricAlarmRequest.WithComparisonOperator(System.String)"> <summary> Sets the ComparisonOperator property </summary> <param name="comparisonOperator">The value to set for the ComparisonOperator property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.AlarmName"> <summary> The descriptive name for the alarm. This name must be unique within the user's AWS account <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.AlarmDescription"> <summary> The description for the alarm. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.ActionsEnabled"> <summary> Indicates whether or not actions should be executed during any changes to the alarm's state. </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.OKActions"> <summary> The list of actions to execute when this alarm transitions into an <c>OK</c> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.AlarmActions"> <summary> The list of actions to execute when this alarm transitions into an <c>ALARM</c> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.InsufficientDataActions"> <summary> The list of actions to execute when this alarm transitions into an <c>INSUFFICIENT_DATA</c> state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 5</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.MetricName"> <summary> The name for the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Namespace"> <summary> The namespace for the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> <item> <term>Pattern</term> <description>[^:].*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Statistic"> <summary> The statistic to apply to the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>SampleCount, Average, Sum, Minimum, Maximum</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Dimensions"> <summary> The dimensions for the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Period"> <summary> The period in seconds over which the specified statistic is applied. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>60 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Unit"> <summary> The unit for the alarm's associated metric. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.EvaluationPeriods"> <summary> The number of periods over which data is compared to the specified threshold. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Threshold"> <summary> The value against which the specified statistic is compared. </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.ComparisonOperator"> <summary> The arithmetic operation to use when comparing the specified <c>Statistic</c> and <c>Threshold</c>. The specified <c>Statistic</c> value is used as the first operand. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.PutMetricAlarmResponse"> <summary> Returns information about the PutMetricAlarm response metadata. The PutMetricAlarm operation has a void result type. </summary> </member> <member name="T:Amazon.CloudWatch.Model.PutMetricDataRequest"> <summary> Container for the parameters to the PutMetricData operation. <para> 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. </para> <para><b>NOTE:</b> If you create a metric with the PutMetricData action, allow up to fifteen minutes for the metric to appear in calls to the ListMetrics action. </para> <para> The size of a PutMetricData request is limited to 8 KB for HTTP GET requests and 40 KB for HTTP POST requests. </para> <para><b>IMPORTANT:</b> Although the Value parameter accepts numbers of type Double, Amazon CloudWatch truncates values with very large exponents. Values with base-10 exponents greater than 126 (1 x 10^126) are truncated. Likewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricDataRequest.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="namespaceValue">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricDataRequest.WithMetricData(Amazon.CloudWatch.Model.MetricDatum[])"> <summary> Adds elements to the MetricData collection </summary> <param name="metricData">The values to add to the MetricData collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.PutMetricDataRequest.WithMetricData(System.Collections.Generic.IEnumerable{Amazon.CloudWatch.Model.MetricDatum})"> <summary> Adds elements to the MetricData collection </summary> <param name="metricData">The values to add to the MetricData collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricDataRequest.Namespace"> <summary> The namespace for the metric data. <note> You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for other Amazon Web Services products that send metrics to Amazon CloudWatch. </note> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> <item> <term>Pattern</term> <description>[^:].*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricDataRequest.MetricData"> <summary> A list of data describing the metric. </summary> </member> <member name="T:Amazon.CloudWatch.Model.PutMetricDataResponse"> <summary> Returns information about the PutMetricData response metadata. The PutMetricData operation has a void result type. </summary> </member> <member name="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> <summary> AmazonCloudWatch exception </summary> </member> <member name="M:Amazon.CloudWatch.Model.ResourceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ResourceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatch.Model.SetAlarmStateRequest"> <summary> Container for the parameters to the SetAlarmState operation. <para> Temporarily sets the state of an alarm. When the updated <c>StateValue</c> differs from the previous value, the action configured for the appropriate state is invoked. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. </para> </summary> <seealso cref="M:Amazon.CloudWatch.AmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"/> </member> <member name="M:Amazon.CloudWatch.Model.SetAlarmStateRequest.WithAlarmName(System.String)"> <summary> Sets the AlarmName property </summary> <param name="alarmName">The value to set for the AlarmName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.SetAlarmStateRequest.WithStateValue(System.String)"> <summary> Sets the StateValue property </summary> <param name="stateValue">The value to set for the StateValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.SetAlarmStateRequest.WithStateReason(System.String)"> <summary> Sets the StateReason property </summary> <param name="stateReason">The value to set for the StateReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.SetAlarmStateRequest.WithStateReasonData(System.String)"> <summary> Sets the StateReasonData property </summary> <param name="stateReasonData">The value to set for the StateReasonData property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.AlarmName"> <summary> The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.StateValue"> <summary> The value of the state. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>OK, ALARM, INSUFFICIENT_DATA</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.StateReason"> <summary> The reason that this alarm is set to this specific state (in human-readable text format) <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1023</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.StateReasonData"> <summary> The reason that this alarm is set to this specific state (in machine-readable JSON format) <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 4000</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.SetAlarmStateResponse"> <summary> Returns information about the SetAlarmState response metadata. The SetAlarmState operation has a void result type. </summary> </member> <member name="T:Amazon.CloudWatch.Model.StatisticSet"> <summary> <para> The <c>StatisticSet</c> data type describes the <c>StatisticValues</c> component of MetricDatum, and represents a set of statistics that describes a specific metric. </para> </summary> </member> <member name="M:Amazon.CloudWatch.Model.StatisticSet.WithSampleCount(System.Double)"> <summary> Sets the SampleCount property </summary> <param name="sampleCount">The value to set for the SampleCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.StatisticSet.WithSum(System.Double)"> <summary> Sets the Sum property </summary> <param name="sum">The value to set for the Sum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.StatisticSet.WithMinimum(System.Double)"> <summary> Sets the Minimum property </summary> <param name="minimum">The value to set for the Minimum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.CloudWatch.Model.StatisticSet.WithMaximum(System.Double)"> <summary> Sets the Maximum property </summary> <param name="maximum">The value to set for the Maximum property </param> <returns>this instance</returns> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.SampleCount"> <summary> The number of samples used for the statistic set. </summary> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.Sum"> <summary> The sum of values for the sample set. </summary> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.Minimum"> <summary> The minimum value of the sample set. </summary> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.Maximum"> <summary> The maximum value of the sample set. </summary> </member> <member name="T:Amazon.DataPipeline.AmazonDataPipeline"> <summary> Interface for accessing AmazonDataPipeline. <para> This is the <i>AWS Data Pipeline API Reference</i> . This guide provides descriptions and samples of the AWS Data Pipeline API. </para> <para> AWS Data Pipeline is a web service that 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 your application can focus on processing the data.</para> <para> The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. </para> <para> The second set of actions are used by a task runner application that calls the AWS Data Pipeline API 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> <para> AWS Data Pipeline provides an open-source 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> The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams. </para> </summary> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"> <summary> <para> Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails. </para> <para> Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated. </para> </summary> <param name="activatePipelineRequest">Container for the necessary parameters to execute the ActivatePipeline service method on AmazonDataPipeline.</param> <returns>The response from the ActivatePipeline service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ActivatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"/> </summary> <param name="activatePipelineRequest">Container for the necessary parameters to execute the ActivatePipeline operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndActivatePipeline operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndActivatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ActivatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginActivatePipeline.</param> <returns>Returns a ActivatePipelineResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"> <summary> <para>Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access. </para> </summary> <param name="listPipelinesRequest">Container for the necessary parameters to execute the ListPipelines service method on AmazonDataPipeline.</param> <returns>The response from the ListPipelines service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"/> </summary> <param name="listPipelinesRequest">Container for the necessary parameters to execute the ListPipelines operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelines operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndListPipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.ListPipelines"> <summary> <para>Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access. </para> </summary> <returns>The response from the ListPipelines service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"> <summary> <para> Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent PollForTask 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 <c>reportProgressTimeout</c> field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds. </para> </summary> <param name="reportTaskProgressRequest">Container for the necessary parameters to execute the ReportTaskProgress service method on AmazonDataPipeline.</param> <returns>The response from the ReportTaskProgress service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskProgress operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"/> </summary> <param name="reportTaskProgressRequest">Container for the necessary parameters to execute the ReportTaskProgress operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReportTaskProgress operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndReportTaskProgress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportTaskProgress operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskProgress.</param> <returns>Returns a ReportTaskProgressResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"> <summary> <para>Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error. </para> </summary> <param name="validatePipelineDefinitionRequest">Container for the necessary parameters to execute the ValidatePipelineDefinition service method on AmazonDataPipeline.</param> <returns>The response from the ValidatePipelineDefinition service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidatePipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"/> </summary> <param name="validatePipelineDefinitionRequest">Container for the necessary parameters to execute the ValidatePipelineDefinition operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidatePipelineDefinition operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndValidatePipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidatePipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidatePipelineDefinition.</param> <returns>Returns a ValidatePipelineDefinitionResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"> <summary> <para> Task runners call this action 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 workerGroup parameter of the PollForTask call. The task returned by PollForTask may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. </para> <para> If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask 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 PollForTask again on the same <c>workerGroup</c> until it receives a response, and this may take up to 90 seconds. </para> </summary> <param name="pollForTaskRequest">Container for the necessary parameters to execute the PollForTask service method on AmazonDataPipeline.</param> <returns>The response from the PollForTask service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginPollForTask(Amazon.DataPipeline.Model.PollForTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForTask operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"/> </summary> <param name="pollForTaskRequest">Container for the necessary parameters to execute the PollForTask operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForTask operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndPollForTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PollForTask operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForTask.</param> <returns>Returns a PollForTaskResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"> <summary> <para>Queries a pipeline for the names of objects that match a specified set of conditions.</para> <para>The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If <c>HasMoreResults</c> is set to <c>True</c> , you should continue to call QueryObjects, passing in the returned value for marker, until <c>HasMoreResults</c> returns <c>False</c> .</para> </summary> <param name="queryObjectsRequest">Container for the necessary parameters to execute the QueryObjects service method on AmazonDataPipeline.</param> <returns>The response from the QueryObjects service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginQueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the QueryObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"/> </summary> <param name="queryObjectsRequest">Container for the necessary parameters to execute the QueryObjects operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndQueryObjects operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndQueryObjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the QueryObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQueryObjects.</param> <returns>Returns a QueryObjectsResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"> <summary> <para>Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.</para> </summary> <param name="setStatusRequest">Container for the necessary parameters to execute the SetStatus service method on AmazonDataPipeline.</param> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginSetStatus(Amazon.DataPipeline.Model.SetStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"/> </summary> <param name="setStatusRequest">Container for the necessary parameters to execute the SetStatus operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndSetStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStatus.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"> <summary> <para> Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. </para> <para> To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to Pause on individual components. Components that are paused by SetStatus can be resumed. </para> </summary> <param name="deletePipelineRequest">Container for the necessary parameters to execute the DeletePipeline service method on AmazonDataPipeline.</param> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginDeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"/> </summary> <param name="deletePipelineRequest">Container for the necessary parameters to execute the DeletePipeline operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"> <summary> <para>Returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition.</para> </summary> <param name="getPipelineDefinitionRequest">Container for the necessary parameters to execute the GetPipelineDefinition service method on AmazonDataPipeline.</param> <returns>The response from the GetPipelineDefinition service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginGetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"/> </summary> <param name="getPipelineDefinitionRequest">Container for the necessary parameters to execute the GetPipelineDefinition operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineDefinition operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndGetPipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipelineDefinition.</param> <returns>Returns a GetPipelineDefinitionResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"> <summary> <para> Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. </para> </summary> <param name="setTaskStatusRequest">Container for the necessary parameters to execute the SetTaskStatus service method on AmazonDataPipeline.</param> <returns>The response from the SetTaskStatus service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginSetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetTaskStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"/> </summary> <param name="setTaskStatusRequest">Container for the necessary parameters to execute the SetTaskStatus operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetTaskStatus operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndSetTaskStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetTaskStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetTaskStatus.</param> <returns>Returns a SetTaskStatusResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"> <summary> <para>Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3. </para> </summary> <param name="evaluateExpressionRequest">Container for the necessary parameters to execute the EvaluateExpression service method on AmazonDataPipeline.</param> <returns>The response from the EvaluateExpression service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginEvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EvaluateExpression operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"/> </summary> <param name="evaluateExpressionRequest">Container for the necessary parameters to execute the EvaluateExpression operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEvaluateExpression operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndEvaluateExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EvaluateExpression operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEvaluateExpression.</param> <returns>Returns a EvaluateExpressionResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"> <summary> <para> Retrieve 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 you have read permission for. </para> <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action. </para> </summary> <param name="describePipelinesRequest">Container for the necessary parameters to execute the DescribePipelines service method on AmazonDataPipeline.</param> <returns>The response from the DescribePipelines service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginDescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"/> </summary> <param name="describePipelinesRequest">Container for the necessary parameters to execute the DescribePipelines operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePipelines operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndDescribePipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePipelines.</param> <returns>Returns a DescribePipelinesResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"> <summary> <para>Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.</para> </summary> <param name="createPipelineRequest">Container for the necessary parameters to execute the CreatePipeline service method on AmazonDataPipeline.</param> <returns>The response from the CreatePipeline service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginCreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"/> </summary> <param name="createPipelineRequest">Container for the necessary parameters to execute the CreatePipeline operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePipeline operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndCreatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"> <summary> <para> Returns 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. </para> </summary> <param name="describeObjectsRequest">Container for the necessary parameters to execute the DescribeObjects service method on AmazonDataPipeline.</param> <returns>The response from the DescribeObjects service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginDescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"/> </summary> <param name="describeObjectsRequest">Container for the necessary parameters to execute the DescribeObjects operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeObjects operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndDescribeObjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeObjects.</param> <returns>Returns a DescribeObjectsResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"> <summary> <para>Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner 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.</para> </summary> <param name="reportTaskRunnerHeartbeatRequest">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method on AmazonDataPipeline.</param> <returns>The response from the ReportTaskRunnerHeartbeat service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"/> </summary> <param name="reportTaskRunnerHeartbeatRequest">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReportTaskRunnerHeartbeat operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndReportTaskRunnerHeartbeat(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportTaskRunnerHeartbeat operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskRunnerHeartbeat.</param> <returns>Returns a ReportTaskRunnerHeartbeatResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"> <summary> <para>Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline or to update an existing pipeline that has not yet been activated. </para> <para> PutPipelineDefinition 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. <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> </ol> </para> <para> Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. </para> </summary> <param name="putPipelineDefinitionRequest">Container for the necessary parameters to execute the PutPipelineDefinition service method on AmazonDataPipeline.</param> <returns>The response from the PutPipelineDefinition service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.BeginPutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"/> </summary> <param name="putPipelineDefinitionRequest">Container for the necessary parameters to execute the PutPipelineDefinition operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPipelineDefinition operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipeline.EndPutPipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutPipelineDefinition.</param> <returns>Returns a PutPipelineDefinitionResult from AmazonDataPipeline.</returns> </member> <member name="T:Amazon.DataPipeline.AmazonDataPipelineClient"> <summary> Implementation for accessing AmazonDataPipeline. <para> This is the <i>AWS Data Pipeline API Reference</i> . This guide provides descriptions and samples of the AWS Data Pipeline API. </para> <para> AWS Data Pipeline is a web service that 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 your application can focus on processing the data.</para> <para> The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. </para> <para> The second set of actions are used by a task runner application that calls the AWS Data Pipeline API 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> <para> AWS Data Pipeline provides an open-source 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> The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams. </para> </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDataPipeline 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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> <para> Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails. </para> <para> Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated. </para> </summary> <param name="activatePipelineRequest">Container for the necessary parameters to execute the ActivatePipeline service method on AmazonDataPipeline.</param> <returns>The response from the ActivatePipeline service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ActivatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"/> </summary> <param name="activatePipelineRequest">Container for the necessary parameters to execute the ActivatePipeline operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndActivatePipeline operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndActivatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ActivatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginActivatePipeline.</param> <returns>Returns a ActivatePipelineResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"> <summary> <para>Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access. </para> </summary> <param name="listPipelinesRequest">Container for the necessary parameters to execute the ListPipelines service method on AmazonDataPipeline.</param> <returns>The response from the ListPipelines service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"/> </summary> <param name="listPipelinesRequest">Container for the necessary parameters to execute the ListPipelines operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelines operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndListPipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ListPipelines"> <summary> <para>Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access. </para> </summary> <returns>The response from the ListPipelines service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"> <summary> <para> Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent PollForTask 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 <c>reportProgressTimeout</c> field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds. </para> </summary> <param name="reportTaskProgressRequest">Container for the necessary parameters to execute the ReportTaskProgress service method on AmazonDataPipeline.</param> <returns>The response from the ReportTaskProgress service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskProgress operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"/> </summary> <param name="reportTaskProgressRequest">Container for the necessary parameters to execute the ReportTaskProgress operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReportTaskProgress operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndReportTaskProgress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportTaskProgress operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskProgress.</param> <returns>Returns a ReportTaskProgressResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"> <summary> <para>Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error. </para> </summary> <param name="validatePipelineDefinitionRequest">Container for the necessary parameters to execute the ValidatePipelineDefinition service method on AmazonDataPipeline.</param> <returns>The response from the ValidatePipelineDefinition service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidatePipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"/> </summary> <param name="validatePipelineDefinitionRequest">Container for the necessary parameters to execute the ValidatePipelineDefinition operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidatePipelineDefinition operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndValidatePipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidatePipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidatePipelineDefinition.</param> <returns>Returns a ValidatePipelineDefinitionResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"> <summary> <para> Task runners call this action 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 workerGroup parameter of the PollForTask call. The task returned by PollForTask may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. </para> <para> If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask 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 PollForTask again on the same <c>workerGroup</c> until it receives a response, and this may take up to 90 seconds. </para> </summary> <param name="pollForTaskRequest">Container for the necessary parameters to execute the PollForTask service method on AmazonDataPipeline.</param> <returns>The response from the PollForTask service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginPollForTask(Amazon.DataPipeline.Model.PollForTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForTask operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"/> </summary> <param name="pollForTaskRequest">Container for the necessary parameters to execute the PollForTask operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForTask operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndPollForTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PollForTask operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForTask.</param> <returns>Returns a PollForTaskResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"> <summary> <para>Queries a pipeline for the names of objects that match a specified set of conditions.</para> <para>The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If <c>HasMoreResults</c> is set to <c>True</c> , you should continue to call QueryObjects, passing in the returned value for marker, until <c>HasMoreResults</c> returns <c>False</c> .</para> </summary> <param name="queryObjectsRequest">Container for the necessary parameters to execute the QueryObjects service method on AmazonDataPipeline.</param> <returns>The response from the QueryObjects service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginQueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the QueryObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"/> </summary> <param name="queryObjectsRequest">Container for the necessary parameters to execute the QueryObjects operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndQueryObjects operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndQueryObjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the QueryObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQueryObjects.</param> <returns>Returns a QueryObjectsResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"> <summary> <para>Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.</para> </summary> <param name="setStatusRequest">Container for the necessary parameters to execute the SetStatus service method on AmazonDataPipeline.</param> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginSetStatus(Amazon.DataPipeline.Model.SetStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"/> </summary> <param name="setStatusRequest">Container for the necessary parameters to execute the SetStatus operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndSetStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStatus.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"> <summary> <para> Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. </para> <para> To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to Pause on individual components. Components that are paused by SetStatus can be resumed. </para> </summary> <param name="deletePipelineRequest">Container for the necessary parameters to execute the DeletePipeline service method on AmazonDataPipeline.</param> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginDeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"/> </summary> <param name="deletePipelineRequest">Container for the necessary parameters to execute the DeletePipeline operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"> <summary> <para>Returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition.</para> </summary> <param name="getPipelineDefinitionRequest">Container for the necessary parameters to execute the GetPipelineDefinition service method on AmazonDataPipeline.</param> <returns>The response from the GetPipelineDefinition service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginGetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"/> </summary> <param name="getPipelineDefinitionRequest">Container for the necessary parameters to execute the GetPipelineDefinition operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineDefinition operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndGetPipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipelineDefinition.</param> <returns>Returns a GetPipelineDefinitionResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"> <summary> <para> Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. </para> </summary> <param name="setTaskStatusRequest">Container for the necessary parameters to execute the SetTaskStatus service method on AmazonDataPipeline.</param> <returns>The response from the SetTaskStatus service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginSetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetTaskStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"/> </summary> <param name="setTaskStatusRequest">Container for the necessary parameters to execute the SetTaskStatus operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetTaskStatus operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndSetTaskStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetTaskStatus operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetTaskStatus.</param> <returns>Returns a SetTaskStatusResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"> <summary> <para>Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3. </para> </summary> <param name="evaluateExpressionRequest">Container for the necessary parameters to execute the EvaluateExpression service method on AmazonDataPipeline.</param> <returns>The response from the EvaluateExpression service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginEvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EvaluateExpression operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"/> </summary> <param name="evaluateExpressionRequest">Container for the necessary parameters to execute the EvaluateExpression operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEvaluateExpression operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndEvaluateExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EvaluateExpression operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEvaluateExpression.</param> <returns>Returns a EvaluateExpressionResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"> <summary> <para> Retrieve 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 you have read permission for. </para> <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action. </para> </summary> <param name="describePipelinesRequest">Container for the necessary parameters to execute the DescribePipelines service method on AmazonDataPipeline.</param> <returns>The response from the DescribePipelines service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginDescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"/> </summary> <param name="describePipelinesRequest">Container for the necessary parameters to execute the DescribePipelines operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePipelines operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndDescribePipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePipelines operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePipelines.</param> <returns>Returns a DescribePipelinesResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"> <summary> <para>Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.</para> </summary> <param name="createPipelineRequest">Container for the necessary parameters to execute the CreatePipeline service method on AmazonDataPipeline.</param> <returns>The response from the CreatePipeline service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginCreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"/> </summary> <param name="createPipelineRequest">Container for the necessary parameters to execute the CreatePipeline operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePipeline operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndCreatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePipeline operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"> <summary> <para> Returns 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. </para> </summary> <param name="describeObjectsRequest">Container for the necessary parameters to execute the DescribeObjects service method on AmazonDataPipeline.</param> <returns>The response from the DescribeObjects service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginDescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"/> </summary> <param name="describeObjectsRequest">Container for the necessary parameters to execute the DescribeObjects operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeObjects operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndDescribeObjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeObjects operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeObjects.</param> <returns>Returns a DescribeObjectsResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"> <summary> <para>Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner 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.</para> </summary> <param name="reportTaskRunnerHeartbeatRequest">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method on AmazonDataPipeline.</param> <returns>The response from the ReportTaskRunnerHeartbeat service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"/> </summary> <param name="reportTaskRunnerHeartbeatRequest">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReportTaskRunnerHeartbeat operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndReportTaskRunnerHeartbeat(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportTaskRunnerHeartbeat operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskRunnerHeartbeat.</param> <returns>Returns a ReportTaskRunnerHeartbeatResult from AmazonDataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"> <summary> <para>Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline or to update an existing pipeline that has not yet been activated. </para> <para> PutPipelineDefinition 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. <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> </ol> </para> <para> Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. </para> </summary> <param name="putPipelineDefinitionRequest">Container for the necessary parameters to execute the PutPipelineDefinition service method on AmazonDataPipeline.</param> <returns>The response from the PutPipelineDefinition service method, as returned by AmazonDataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"/> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"/> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"/> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"/> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginPutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"/> </summary> <param name="putPipelineDefinitionRequest">Container for the necessary parameters to execute the PutPipelineDefinition operation on AmazonDataPipeline.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutPipelineDefinition operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndPutPipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutPipelineDefinition operation. <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutPipelineDefinition.</param> <returns>Returns a PutPipelineDefinitionResult from AmazonDataPipeline.</returns> </member> <member name="T:Amazon.DataPipeline.AmazonDataPipelineConfig"> <summary> Configuration for accessing service </summary> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.DataPipeline.AmazonDataPipelineConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.DataPipeline.AmazonDataPipelineConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ActivatePipelineRequest"> <summary> Container for the parameters to the ActivatePipeline operation. <para> Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails. </para> <para> Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.ActivatePipelineRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ActivatePipelineRequest.PipelineId"> <summary> The identifier of the pipeline to activate. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ActivatePipelineResponse"> <summary> Returns information about the ActivatePipelineResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ActivatePipelineResponse.ActivatePipelineResult"> <summary> Gets and sets the ActivatePipelineResult property. Contains the output from the ActivatePipeline action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ActivatePipelineResult"> <summary> <para>Contains the output from the ActivatePipeline action.</para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.CreatePipelineRequest"> <summary> Container for the parameters to the CreatePipeline operation. <para>Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.</para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.CreatePipelineRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.CreatePipelineRequest.WithUniqueId(System.String)"> <summary> Sets the UniqueId property </summary> <param name="uniqueId">The value to set for the UniqueId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.CreatePipelineRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineRequest.Name"> <summary> The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineRequest.UniqueId"> <summary> A unique identifier that you specify. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to <a>CreatePipeline</a>. For example, if the first call to <a>CreatePipeline</a> does not return a clear success, you can pass in the same unique identifier and pipeline name combination on a subsequent call to <a>CreatePipeline</a>. <a>CreatePipeline</a> ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline will not be created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineRequest.Description"> <summary> The description of the new pipeline. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.CreatePipelineResponse"> <summary> Returns information about the CreatePipelineResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineResponse.CreatePipelineResult"> <summary> Gets and sets the CreatePipelineResult property. Contains the output from the CreatePipeline action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.CreatePipelineResult"> <summary> <para>Contains the output from the CreatePipeline action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.CreatePipelineResult.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineResult.PipelineId"> <summary> The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a string of the form: df-06372391ZG65EXAMPLE. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.DeletePipelineRequest"> <summary> Container for the parameters to the DeletePipeline operation. <para> Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. </para> <para> To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to Pause on individual components. Components that are paused by SetStatus can be resumed. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.DeletePipelineRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.DeletePipelineRequest.PipelineId"> <summary> The identifier of the pipeline to be deleted. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.DeletePipelineResponse"> <summary> Returns information about the DeletePipeline response metadata. The DeletePipeline operation has a void result type. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribeObjectsRequest"> <summary> Container for the parameters to the DescribeObjects operation. <para> Returns 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. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsRequest.WithObjectIds(System.String[])"> <summary> Adds elements to the ObjectIds collection </summary> <param name="objectIds">The values to add to the ObjectIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsRequest.WithObjectIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the ObjectIds collection </summary> <param name="objectIds">The values to add to the ObjectIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsRequest.WithEvaluateExpressions(System.Boolean)"> <summary> Sets the EvaluateExpressions property </summary> <param name="evaluateExpressions">The value to set for the EvaluateExpressions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.PipelineId"> <summary> Identifier of the pipeline that contains the object definitions. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.ObjectIds"> <summary> Identifiers of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.EvaluateExpressions"> <summary> Indicates whether any expressions in the object should be evaluated when the object descriptions are returned. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.Marker"> <summary> The starting point for the results to be returned. The first time you call <a>DescribeObjects</a>, this value should be empty. As long as the action returns <c>HasMoreResults</c> as <c>True</c>, you can call <a>DescribeObjects</a> again and pass the marker value from the response to retrieve the next set of results. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribeObjectsResponse"> <summary> Returns information about the DescribeObjectsResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResponse.DescribeObjectsResult"> <summary> Gets and sets the DescribeObjectsResult property. If True, there are more results that can be returned in another call to DescribeObjects. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribeObjectsResult"> <summary> <para>If <c>True</c> , there are more results that can be returned in another call to DescribeObjects.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsResult.WithPipelineObjects(Amazon.DataPipeline.Model.PipelineObject[])"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsResult.WithPipelineObjects(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.PipelineObject})"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribeObjectsResult.WithHasMoreResults(System.Boolean)"> <summary> Sets the HasMoreResults property </summary> <param name="hasMoreResults">The value to set for the HasMoreResults property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResult.PipelineObjects"> <summary> An array of object definitions that are returned by the call to <a>DescribeObjects</a>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResult.Marker"> <summary> The starting point for the next page of results. To view the next page of results, call <a>DescribeObjects</a> again with this marker value. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResult.HasMoreResults"> <summary> If <c>True</c>, there are more pages of results to return. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribePipelinesRequest"> <summary> Container for the parameters to the DescribePipelines operation. <para> Retrieve 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 you have read permission for. </para> <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.DescribePipelinesRequest.WithPipelineIds(System.String[])"> <summary> Adds elements to the PipelineIds collection </summary> <param name="pipelineIds">The values to add to the PipelineIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribePipelinesRequest.WithPipelineIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the PipelineIds collection </summary> <param name="pipelineIds">The values to add to the PipelineIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.DescribePipelinesRequest.PipelineIds"> <summary> Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to <a>DescribePipelines</a>. You can obtain pipeline identifiers by calling <a>ListPipelines</a>. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribePipelinesResponse"> <summary> Returns information about the DescribePipelinesResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribePipelinesResponse.DescribePipelinesResult"> <summary> Gets and sets the DescribePipelinesResult property. Contains the output from the DescribePipelines action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribePipelinesResult"> <summary> <para>Contains the output from the DescribePipelines action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.DescribePipelinesResult.WithPipelineDescriptionList(Amazon.DataPipeline.Model.PipelineDescription[])"> <summary> Adds elements to the PipelineDescriptionList collection </summary> <param name="pipelineDescriptionList">The values to add to the PipelineDescriptionList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.DescribePipelinesResult.WithPipelineDescriptionList(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.PipelineDescription})"> <summary> Adds elements to the PipelineDescriptionList collection </summary> <param name="pipelineDescriptionList">The values to add to the PipelineDescriptionList collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.DescribePipelinesResult.PipelineDescriptionList"> <summary> An array of descriptions returned for the specified pipelines. </summary> </member> <member name="T:Amazon.DataPipeline.Model.EvaluateExpressionRequest"> <summary> Container for the parameters to the EvaluateExpression operation. <para>Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.EvaluateExpressionRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.EvaluateExpressionRequest.WithObjectId(System.String)"> <summary> Sets the ObjectId property </summary> <param name="objectId">The value to set for the ObjectId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.EvaluateExpressionRequest.WithExpression(System.String)"> <summary> Sets the Expression property </summary> <param name="expression">The value to set for the Expression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionRequest.PipelineId"> <summary> The identifier of the pipeline. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionRequest.ObjectId"> <summary> The identifier of the object. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionRequest.Expression"> <summary> The expression to evaluate. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 20971520</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.EvaluateExpressionResponse"> <summary> Returns information about the EvaluateExpressionResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionResponse.EvaluateExpressionResult"> <summary> Gets and sets the EvaluateExpressionResult property. Contains the output from the EvaluateExpression action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.EvaluateExpressionResult"> <summary> <para>Contains the output from the EvaluateExpression action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.EvaluateExpressionResult.WithEvaluatedExpression(System.String)"> <summary> Sets the EvaluatedExpression property </summary> <param name="evaluatedExpression">The value to set for the EvaluatedExpression property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionResult.EvaluatedExpression"> <summary> The evaluated expression. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 20971520</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.Field"> <summary> <para>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value ( <c>StringValue</c> ) or a reference to another object ( <c>RefValue</c> ) but not as both.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.Field.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.Field.WithStringValue(System.String)"> <summary> Sets the StringValue property </summary> <param name="stringValue">The value to set for the StringValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.Field.WithRefValue(System.String)"> <summary> Sets the RefValue property </summary> <param name="refValue">The value to set for the RefValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.Field.Key"> <summary> The field identifier. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 256</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Field.StringValue"> <summary> The field value, expressed as a String. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 10240</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Field.RefValue"> <summary> The field value, expressed as the identifier of another object. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 256</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest"> <summary> Container for the parameters to the GetPipelineDefinition operation. <para>Returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition.</para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest.WithVersion(System.String)"> <summary> Sets the Version property </summary> <param name="version">The value to set for the Version property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest.PipelineId"> <summary> The identifier of the pipeline. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest.Version"> <summary> The version of the pipeline definition to retrieve. This parameter accepts the values <c>latest</c> (default) and <c>active</c>. Where <c>latest</c> indicates the last definition saved to the pipeline and <c>active</c> indicates the last definition of the pipeline that was activated. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.GetPipelineDefinitionResponse"> <summary> Returns information about the GetPipelineDefinitionResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionResponse.GetPipelineDefinitionResult"> <summary> Gets and sets the GetPipelineDefinitionResult property. Contains the output from the GetPipelineDefinition action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.GetPipelineDefinitionResult"> <summary> <para>Contains the output from the GetPipelineDefinition action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.GetPipelineDefinitionResult.WithPipelineObjects(Amazon.DataPipeline.Model.PipelineObject[])"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.GetPipelineDefinitionResult.WithPipelineObjects(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.PipelineObject})"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionResult.PipelineObjects"> <summary> An array of objects defined in the pipeline. </summary> </member> <member name="T:Amazon.DataPipeline.Model.InstanceIdentity"> <summary> <para> <para>Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, go to Instance Metadata in the <i>Amazon Elastic Compute Cloud User Guide.</i> Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</para> </para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.InstanceIdentity.WithDocument(System.String)"> <summary> Sets the Document property </summary> <param name="document">The value to set for the Document property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.InstanceIdentity.WithSignature(System.String)"> <summary> Sets the Signature property </summary> <param name="signature">The value to set for the Signature property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.InstanceIdentity.Document"> <summary> A description of an Amazon EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.InstanceIdentity.Signature"> <summary> A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> <summary> AmazonDataPipeline exception </summary> </member> <member name="M:Amazon.DataPipeline.Model.InternalServiceErrorException.#ctor(System.String)"> <summary> Constructs a new InternalServiceErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ActivatePipelineRequestMarshaller"> <summary> Activate Pipeline Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ActivatePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for ActivatePipeline operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ActivatePipelineResultUnmarshaller"> <summary> ActivatePipelineResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.CreatePipelineRequestMarshaller"> <summary> Create Pipeline Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.CreatePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePipeline operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.CreatePipelineResultUnmarshaller"> <summary> CreatePipelineResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DeletePipelineRequestMarshaller"> <summary> Delete Pipeline Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DeletePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for DeletePipeline operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DescribeObjectsRequestMarshaller"> <summary> Describe Objects Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DescribeObjectsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeObjects operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DescribeObjectsResultUnmarshaller"> <summary> DescribeObjectsResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DescribePipelinesRequestMarshaller"> <summary> Describe Pipelines Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DescribePipelinesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribePipelines operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DescribePipelinesResultUnmarshaller"> <summary> DescribePipelinesResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.EvaluateExpressionRequestMarshaller"> <summary> Evaluate Expression Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.EvaluateExpressionResponseUnmarshaller"> <summary> Response Unmarshaller for EvaluateExpression operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.EvaluateExpressionResultUnmarshaller"> <summary> EvaluateExpressionResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.FieldUnmarshaller"> <summary> FieldUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.GetPipelineDefinitionRequestMarshaller"> <summary> Get Pipeline Definition Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.GetPipelineDefinitionResponseUnmarshaller"> <summary> Response Unmarshaller for GetPipelineDefinition operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.GetPipelineDefinitionResultUnmarshaller"> <summary> GetPipelineDefinitionResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ListPipelinesRequestMarshaller"> <summary> List Pipelines Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ListPipelinesResponseUnmarshaller"> <summary> Response Unmarshaller for ListPipelines operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ListPipelinesResultUnmarshaller"> <summary> ListPipelinesResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PipelineDescriptionUnmarshaller"> <summary> PipelineDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PipelineIdNameUnmarshaller"> <summary> PipelineIdNameUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PipelineObjectUnmarshaller"> <summary> PipelineObjectUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PollForTaskRequestMarshaller"> <summary> Poll For Task Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PollForTaskResponseUnmarshaller"> <summary> Response Unmarshaller for PollForTask operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PollForTaskResultUnmarshaller"> <summary> PollForTaskResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PutPipelineDefinitionRequestMarshaller"> <summary> Put Pipeline Definition Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PutPipelineDefinitionResponseUnmarshaller"> <summary> Response Unmarshaller for PutPipelineDefinition operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PutPipelineDefinitionResultUnmarshaller"> <summary> PutPipelineDefinitionResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.QueryObjectsRequestMarshaller"> <summary> Query Objects Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.QueryObjectsResponseUnmarshaller"> <summary> Response Unmarshaller for QueryObjects operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.QueryObjectsResultUnmarshaller"> <summary> QueryObjectsResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ReportTaskProgressRequestMarshaller"> <summary> Report Task Progress Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ReportTaskProgressResponseUnmarshaller"> <summary> Response Unmarshaller for ReportTaskProgress operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ReportTaskProgressResultUnmarshaller"> <summary> ReportTaskProgressResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ReportTaskRunnerHeartbeatRequestMarshaller"> <summary> Report Task Runner Heartbeat Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ReportTaskRunnerHeartbeatResponseUnmarshaller"> <summary> Response Unmarshaller for ReportTaskRunnerHeartbeat operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ReportTaskRunnerHeartbeatResultUnmarshaller"> <summary> ReportTaskRunnerHeartbeatResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.SetStatusRequestMarshaller"> <summary> Set Status Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.SetStatusResponseUnmarshaller"> <summary> Response Unmarshaller for SetStatus operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.SetTaskStatusRequestMarshaller"> <summary> Set Task Status Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.SetTaskStatusResponseUnmarshaller"> <summary> Response Unmarshaller for SetTaskStatus operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.SetTaskStatusResultUnmarshaller"> <summary> SetTaskStatusResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.TaskObjectUnmarshaller"> <summary> TaskObjectUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ValidatePipelineDefinitionRequestMarshaller"> <summary> Validate Pipeline Definition Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ValidatePipelineDefinitionResponseUnmarshaller"> <summary> Response Unmarshaller for ValidatePipelineDefinition operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ValidatePipelineDefinitionResultUnmarshaller"> <summary> ValidatePipelineDefinitionResultUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ValidationErrorUnmarshaller"> <summary> ValidationErrorUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ValidationWarningUnmarshaller"> <summary> ValidationWarningUnmarshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.InvalidRequestException"> <summary> AmazonDataPipeline exception </summary> </member> <member name="M:Amazon.DataPipeline.Model.InvalidRequestException.#ctor(System.String)"> <summary> Constructs a new InvalidRequestException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DataPipeline.Model.ListPipelinesRequest"> <summary> Container for the parameters to the ListPipelines operation. <para>Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.ListPipelinesRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesRequest.Marker"> <summary> The starting point for the results to be returned. The first time you call <a>ListPipelines</a>, this value should be empty. As long as the action returns <c>HasMoreResults</c> as <c>True</c>, you can call <a>ListPipelines</a> again and pass the marker value from the response to retrieve the next set of results. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ListPipelinesResponse"> <summary> Returns information about the ListPipelinesResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResponse.ListPipelinesResult"> <summary> Gets and sets the ListPipelinesResult property. Contains the output from the ListPipelines action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ListPipelinesResult"> <summary> <para>Contains the output from the ListPipelines action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.ListPipelinesResult.WithPipelineIdList(Amazon.DataPipeline.Model.PipelineIdName[])"> <summary> Adds elements to the PipelineIdList collection </summary> <param name="pipelineIdList">The values to add to the PipelineIdList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ListPipelinesResult.WithPipelineIdList(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.PipelineIdName})"> <summary> Adds elements to the PipelineIdList collection </summary> <param name="pipelineIdList">The values to add to the PipelineIdList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ListPipelinesResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ListPipelinesResult.WithHasMoreResults(System.Boolean)"> <summary> Sets the HasMoreResults property </summary> <param name="hasMoreResults">The value to set for the HasMoreResults property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResult.PipelineIdList"> <summary> A list of all the pipeline identifiers that your account has permission to access. If you require additional information about the pipelines, you can use these identifiers to call <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResult.Marker"> <summary> If not null, indicates the starting point for the set of pipeline identifiers that the next call to <a>ListPipelines</a> will retrieve. If null, there are no more pipeline identifiers. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResult.HasMoreResults"> <summary> If <c>True</c>, there are more results that can be obtained by a subsequent call to <a>ListPipelines</a>. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Operator"> <summary> <para>Contains a logical operation for comparing the value of a field with a specified value.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.Operator.WithType(System.String)"> <summary> Sets the Type property </summary> <param name="type">The value to set for the Type property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.Operator.WithValues(System.String[])"> <summary> Adds elements to the Values collection </summary> <param name="values">The values to add to the Values collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.Operator.WithValues(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Values collection </summary> <param name="values">The values to add to the Values collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.Operator.Type"> <summary> The logical operation to be performed: equal (<c>EQ</c>), equal reference (<c>REF_EQ</c>), less than or equal (<c>LE</c>), greater than or equal (<c>GE</c>), or between (<c>BETWEEN</c>). Equal reference (<c>REF_EQ</c>) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. The comparison operators EQ and REF_EQ act on the following fields: <ul> <li>name</li> <li>@sphere</li> <li>parent</li> <li>@componentParent</li> <li>@instanceParent</li> <li>@status</li> <li>@scheduledStartTime</li> <li>@scheduledEndTime</li> <li>@actualStartTime</li> <li>@actualEndTime</li> </ul> The comparison operators <c>GE</c>, <c>LE</c>, and <c>BETWEEN</c> act on the following fields: <ul> <li>@scheduledStartTime</li> <li>@scheduledEndTime</li> <li>@actualStartTime</li> <li>@actualEndTime</li> </ul> Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my". <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>EQ, REF_EQ, LE, GE, BETWEEN</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Operator.Values"> <summary> The value that the actual field value will be compared with. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PipelineDeletedException"> <summary> AmazonDataPipeline exception </summary> </member> <member name="M:Amazon.DataPipeline.Model.PipelineDeletedException.#ctor(System.String)"> <summary> Constructs a new PipelineDeletedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DataPipeline.Model.PipelineDescription"> <summary> <para>Contains pipeline metadata.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.PipelineDescription.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineDescription.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineDescription.WithFields(Amazon.DataPipeline.Model.Field[])"> <summary> Adds elements to the Fields collection </summary> <param name="fields">The values to add to the Fields collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineDescription.WithFields(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.Field})"> <summary> Adds elements to the Fields collection </summary> <param name="fields">The values to add to the Fields collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.PipelineId"> <summary> The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <c>df-297EG78HU43EEXAMPLE</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.Name"> <summary> Name of the pipeline. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.Fields"> <summary> A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.Description"> <summary> Description of the pipeline. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PipelineIdName"> <summary> <para>Contains the name and identifier of a pipeline.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.PipelineIdName.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineIdName.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.PipelineIdName.Id"> <summary> Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form <c>df-297EG78HU43EEXAMPLE</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineIdName.Name"> <summary> Name of the pipeline. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> <summary> AmazonDataPipeline exception </summary> </member> <member name="M:Amazon.DataPipeline.Model.PipelineNotFoundException.#ctor(System.String)"> <summary> Constructs a new PipelineNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DataPipeline.Model.PipelineObject"> <summary> <para>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.PipelineObject.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineObject.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineObject.WithFields(Amazon.DataPipeline.Model.Field[])"> <summary> Adds elements to the Fields collection </summary> <param name="fields">The values to add to the Fields collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PipelineObject.WithFields(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.Field})"> <summary> Adds elements to the Fields collection </summary> <param name="fields">The values to add to the Fields collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.PipelineObject.Id"> <summary> Identifier of the object. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineObject.Name"> <summary> Name of the object. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineObject.Fields"> <summary> Key-value pairs that define the properties of the object. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PollForTaskRequest"> <summary> Container for the parameters to the PollForTask operation. <para> Task runners call this action 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 workerGroup parameter of the PollForTask call. The task returned by PollForTask may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. </para> <para> If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask 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 PollForTask again on the same <c>workerGroup</c> until it receives a response, and this may take up to 90 seconds. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.PollForTaskRequest.WithWorkerGroup(System.String)"> <summary> Sets the WorkerGroup property </summary> <param name="workerGroup">The value to set for the WorkerGroup property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PollForTaskRequest.WithHostname(System.String)"> <summary> Sets the Hostname property </summary> <param name="hostname">The value to set for the Hostname property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PollForTaskRequest.WithInstanceIdentity(Amazon.DataPipeline.Model.InstanceIdentity)"> <summary> Sets the InstanceIdentity property </summary> <param name="instanceIdentity">The value to set for the InstanceIdentity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskRequest.WorkerGroup"> <summary> Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <c>workerGroup</c> in the call to <a>PollForTask</a>. There are no wildcard values permitted in <c>workerGroup</c>, the string must be an exact, case-sensitive, match. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskRequest.Hostname"> <summary> The public DNS name of the calling task runner. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskRequest.InstanceIdentity"> <summary> Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, <c>http://169.254.169.254/latest/meta-data/instance-id</c>, from the EC2 instance. For more information, go to <a href="http://docs.amazonwebservices.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PollForTaskResponse"> <summary> Returns information about the PollForTaskResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskResponse.PollForTaskResult"> <summary> Gets and sets the PollForTaskResult property. Contains the output from the PollForTask action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PollForTaskResult"> <summary> <para>Contains the output from the PollForTask action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.PollForTaskResult.WithTaskObject(Amazon.DataPipeline.Model.TaskObject)"> <summary> Sets the TaskObject property </summary> <param name="taskObject">The value to set for the TaskObject property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskResult.TaskObject"> <summary> An instance of <a>PollForTaskResult</a>, which contains an instance of <a>TaskObject</a>. The returned object contains all the information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to <a>ReportTaskProgress</a> and <a>SetTaskStatus</a>. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest"> <summary> Container for the parameters to the PutPipelineDefinition operation. <para>Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline or to update an existing pipeline that has not yet been activated. </para> <para> PutPipelineDefinition 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. <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> </ol> </para> <para> Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.WithPipelineObjects(Amazon.DataPipeline.Model.PipelineObject[])"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.WithPipelineObjects(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.PipelineObject})"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.PipelineId"> <summary> The identifier of the pipeline to be configured. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.PipelineObjects"> <summary> The objects that define the pipeline. These will overwrite the existing pipeline definition. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PutPipelineDefinitionResponse"> <summary> Returns information about the PutPipelineDefinitionResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResponse.PutPipelineDefinitionResult"> <summary> Gets and sets the PutPipelineDefinitionResult property. Contains the output of the PutPipelineDefinition action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PutPipelineDefinitionResult"> <summary> <para>Contains the output of the PutPipelineDefinition action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.WithValidationErrors(Amazon.DataPipeline.Model.ValidationError[])"> <summary> Adds elements to the ValidationErrors collection </summary> <param name="validationErrors">The values to add to the ValidationErrors collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.WithValidationErrors(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.ValidationError})"> <summary> Adds elements to the ValidationErrors collection </summary> <param name="validationErrors">The values to add to the ValidationErrors collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.WithValidationWarnings(Amazon.DataPipeline.Model.ValidationWarning[])"> <summary> Adds elements to the ValidationWarnings collection </summary> <param name="validationWarnings">The values to add to the ValidationWarnings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.WithValidationWarnings(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.ValidationWarning})"> <summary> Adds elements to the ValidationWarnings collection </summary> <param name="validationWarnings">The values to add to the ValidationWarnings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.WithErrored(System.Boolean)"> <summary> Sets the Errored property </summary> <param name="errored">The value to set for the Errored property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.ValidationErrors"> <summary> A list of the validation errors that are associated with the objects defined in <c>pipelineObjects</c>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.ValidationWarnings"> <summary> A list of the validation warnings that are associated with the objects defined in <c>pipelineObjects</c>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.Errored"> <summary> If <c>True</c>, there were validation errors. If errored is <c>True</c>, the pipeline definition is stored but cannot be activated until you correct the pipeline and call <a>PutPipelineDefinition</a> to commit the corrected pipeline. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Query"> <summary> <para>Defines the query to run against an object.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.Query.WithSelectors(Amazon.DataPipeline.Model.Selector[])"> <summary> Adds elements to the Selectors collection </summary> <param name="selectors">The values to add to the Selectors collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.Query.WithSelectors(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.Selector})"> <summary> Adds elements to the Selectors collection </summary> <param name="selectors">The values to add to the Selectors collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.Query.Selectors"> <summary> List of selectors that define the query. An object must satisfy all of the selectors to match the query. </summary> </member> <member name="T:Amazon.DataPipeline.Model.QueryObjectsRequest"> <summary> Container for the parameters to the QueryObjects operation. <para>Queries a pipeline for the names of objects that match a specified set of conditions.</para> <para>The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If <c>HasMoreResults</c> is set to <c>True</c> , you should continue to call QueryObjects, passing in the returned value for marker, until <c>HasMoreResults</c> returns <c>False</c> .</para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsRequest.WithQuery(Amazon.DataPipeline.Model.Query)"> <summary> Sets the Query property </summary> <param name="query">The value to set for the Query property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsRequest.WithSphere(System.String)"> <summary> Sets the Sphere property </summary> <param name="sphere">The value to set for the Sphere property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.PipelineId"> <summary> Identifier of the pipeline to be queried for object names. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Query"> <summary> Query that defines the objects to be returned. The <a>Query</a> object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts. </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Sphere"> <summary> Specifies whether the query applies to components or instances. Allowable values: <c>COMPONENT</c>, <c>INSTANCE</c>, <c>ATTEMPT</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Marker"> <summary> The starting point for the results to be returned. The first time you call <a>QueryObjects</a>, this value should be empty. As long as the action returns <c>HasMoreResults</c> as <c>True</c>, you can call <a>QueryObjects</a> again and pass the marker value from the response to retrieve the next set of results. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Limit"> <summary> Specifies the maximum number of object names that <a>QueryObjects</a> will return in a single call. The default value is 100. </summary> </member> <member name="T:Amazon.DataPipeline.Model.QueryObjectsResponse"> <summary> Returns information about the QueryObjectsResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResponse.QueryObjectsResult"> <summary> Gets and sets the QueryObjectsResult property. Contains the output from the QueryObjects action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.QueryObjectsResult"> <summary> <para>Contains the output from the QueryObjects action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsResult.WithIds(System.String[])"> <summary> Adds elements to the Ids collection </summary> <param name="ids">The values to add to the Ids collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsResult.WithIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Ids collection </summary> <param name="ids">The values to add to the Ids collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.QueryObjectsResult.WithHasMoreResults(System.Boolean)"> <summary> Sets the HasMoreResults property </summary> <param name="hasMoreResults">The value to set for the HasMoreResults property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResult.Ids"> <summary> A list of identifiers that match the query selectors. </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResult.Marker"> <summary> The starting point for the results to be returned. As long as the action returns <c>HasMoreResults</c> as <c>True</c>, you can call <a>QueryObjects</a> again and pass the marker value from the response to retrieve the next set of results. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResult.HasMoreResults"> <summary> If <c>True</c>, there are more results that can be obtained by a subsequent call to <a>QueryObjects</a>. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskProgressRequest"> <summary> Container for the parameters to the ReportTaskProgress operation. <para> Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent PollForTask 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 <c>reportProgressTimeout</c> field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.ReportTaskProgressRequest.WithTaskId(System.String)"> <summary> Sets the TaskId property </summary> <param name="taskId">The value to set for the TaskId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskProgressRequest.TaskId"> <summary> Identifier of the task assigned to the task runner. This value is provided in the <a>TaskObject</a> that the service returns with the response for the <a>PollForTask</a> action. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2048</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskProgressResponse"> <summary> Returns information about the ReportTaskProgressResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskProgressResponse.ReportTaskProgressResult"> <summary> Gets and sets the ReportTaskProgressResult property. Contains the output from the ReportTaskProgress action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskProgressResult"> <summary> <para>Contains the output from the ReportTaskProgress action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.ReportTaskProgressResult.WithCanceled(System.Boolean)"> <summary> Sets the Canceled property </summary> <param name="canceled">The value to set for the Canceled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskProgressResult.Canceled"> <summary> If <c>True</c>, the calling task runner should cancel processing of the task. The task runner does not need to call <a>SetTaskStatus</a> for canceled tasks. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest"> <summary> Container for the parameters to the ReportTaskRunnerHeartbeat operation. <para>Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner 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.</para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.WithTaskrunnerId(System.String)"> <summary> Sets the TaskrunnerId property </summary> <param name="taskrunnerId">The value to set for the TaskrunnerId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.WithWorkerGroup(System.String)"> <summary> Sets the WorkerGroup property </summary> <param name="workerGroup">The value to set for the WorkerGroup property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.WithHostname(System.String)"> <summary> Sets the Hostname property </summary> <param name="hostname">The value to set for the Hostname property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.TaskrunnerId"> <summary> The identifier of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.WorkerGroup"> <summary> Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <c>workerGroup</c> in the call to <a>ReportTaskRunnerHeartbeat</a>. There are no wildcard values permitted in <c>workerGroup</c>, the string must be an exact, case-sensitive, match. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.Hostname"> <summary> The public DNS name of the calling task runner. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResponse"> <summary> Returns information about the ReportTaskRunnerHeartbeatResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResponse.ReportTaskRunnerHeartbeatResult"> <summary> Gets and sets the ReportTaskRunnerHeartbeatResult property. Contains the output from the ReportTaskRunnerHeartbeat action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResult"> <summary> <para>Contains the output from the ReportTaskRunnerHeartbeat action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResult.WithTerminate(System.Boolean)"> <summary> Sets the Terminate property </summary> <param name="terminate">The value to set for the Terminate property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResult.Terminate"> <summary> Indicates whether the calling task runner should terminate. If <c>True</c>, the task runner that called <a>ReportTaskRunnerHeartbeat</a> should terminate. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Selector"> <summary> <para>A comparision that is used to determine whether a query should return this object.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.Selector.WithFieldName(System.String)"> <summary> Sets the FieldName property </summary> <param name="fieldName">The value to set for the FieldName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.Selector.WithOperator(Amazon.DataPipeline.Model.Operator)"> <summary> Sets the Operator property </summary> <param name="operatorValue">The value to set for the Operator property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.Selector.FieldName"> <summary> The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Selector.Operator"> <summary> Contains a logical operation for comparing the value of a field with a specified value. </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetStatusRequest"> <summary> Container for the parameters to the SetStatus operation. <para>Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.</para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.SetStatusRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.SetStatusRequest.WithObjectIds(System.String[])"> <summary> Adds elements to the ObjectIds collection </summary> <param name="objectIds">The values to add to the ObjectIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.SetStatusRequest.WithObjectIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the ObjectIds collection </summary> <param name="objectIds">The values to add to the ObjectIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.SetStatusRequest.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.SetStatusRequest.PipelineId"> <summary> Identifies the pipeline that contains the objects. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetStatusRequest.ObjectIds"> <summary> Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types. </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetStatusRequest.Status"> <summary> Specifies the status to be set on all the objects in <c>objectIds</c>. For components, this can be either <c>PAUSE</c> or <c>RESUME</c>. For instances, this can be either <c>CANCEL</c>, <c>RERUN</c>, or <c>MARK_FINISHED</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetStatusResponse"> <summary> Returns information about the SetStatus response metadata. The SetStatus operation has a void result type. </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetTaskStatusRequest"> <summary> Container for the parameters to the SetTaskStatus operation. <para> Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.SetTaskStatusRequest.WithTaskId(System.String)"> <summary> Sets the TaskId property </summary> <param name="taskId">The value to set for the TaskId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.SetTaskStatusRequest.WithTaskStatus(System.String)"> <summary> Sets the TaskStatus property </summary> <param name="taskStatus">The value to set for the TaskStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.SetTaskStatusRequest.WithErrorId(System.String)"> <summary> Sets the ErrorId property </summary> <param name="errorId">The value to set for the ErrorId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.SetTaskStatusRequest.WithErrorMessage(System.String)"> <summary> Sets the ErrorMessage property </summary> <param name="errorMessage">The value to set for the ErrorMessage property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.SetTaskStatusRequest.WithErrorStackTrace(System.String)"> <summary> Sets the ErrorStackTrace property </summary> <param name="errorStackTrace">The value to set for the ErrorStackTrace property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.TaskId"> <summary> Identifies the task assigned to the task runner. This value is set in the <a>TaskObject</a> that is returned by the <a>PollForTask</a> action. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2048</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.TaskStatus"> <summary> If <c>FINISHED</c>, the task successfully completed. If <c>FAILED</c> the task ended unsuccessfully. The <c>FALSE</c> value is used by preconditions. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>FINISHED, FAILED, FALSE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.ErrorId"> <summary> If an error occurred during the task, this value specifies an id value that represents the error. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.ErrorMessage"> <summary> If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value. </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.ErrorStackTrace"> <summary> If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>0 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetTaskStatusResponse"> <summary> Returns information about the SetTaskStatusResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusResponse.SetTaskStatusResult"> <summary> Gets and sets the SetTaskStatusResult property. The output from the SetTaskStatus action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetTaskStatusResult"> <summary> <para>The output from the SetTaskStatus action.</para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.TaskNotFoundException"> <summary> AmazonDataPipeline exception </summary> </member> <member name="M:Amazon.DataPipeline.Model.TaskNotFoundException.#ctor(System.String)"> <summary> Constructs a new TaskNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DataPipeline.Model.TaskObject"> <summary> <para>Contains information about a pipeline task that is assigned to a task runner.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.TaskObject.WithTaskId(System.String)"> <summary> Sets the TaskId property </summary> <param name="taskId">The value to set for the TaskId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.TaskObject.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.TaskObject.WithAttemptId(System.String)"> <summary> Sets the AttemptId property </summary> <param name="attemptId">The value to set for the AttemptId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.TaskObject.WithObjects(System.Collections.Generic.KeyValuePair{System.String,Amazon.DataPipeline.Model.PipelineObject}[])"> <summary> Adds the KeyValuePairs to the Objects dictionary. </summary> <param name="pairs">The pairs to be added to the Objects dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.TaskId"> <summary> An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2048</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.PipelineId"> <summary> Identifier of the pipeline that provided the task. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.AttemptId"> <summary> Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.Objects"> <summary> Connection information for the location where the task runner will publish the output of the task. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest"> <summary> Container for the parameters to the ValidatePipelineDefinition operation. <para>Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error. </para> </summary> <seealso cref="M:Amazon.DataPipeline.AmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"/> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.WithPipelineObjects(Amazon.DataPipeline.Model.PipelineObject[])"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.WithPipelineObjects(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.PipelineObject})"> <summary> Adds elements to the PipelineObjects collection </summary> <param name="pipelineObjects">The values to add to the PipelineObjects collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.PipelineId"> <summary> Identifies the pipeline whose definition is to be validated. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.PipelineObjects"> <summary> A list of objects that define the pipeline changes to validate against the pipeline. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResponse"> <summary> Returns information about the ValidatePipelineDefinitionResult response and response metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResponse.ValidatePipelineDefinitionResult"> <summary> Gets and sets the ValidatePipelineDefinitionResult property. Contains the output from the ValidatePipelineDefinition action. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult"> <summary> <para>Contains the output from the ValidatePipelineDefinition action.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.WithValidationErrors(Amazon.DataPipeline.Model.ValidationError[])"> <summary> Adds elements to the ValidationErrors collection </summary> <param name="validationErrors">The values to add to the ValidationErrors collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.WithValidationErrors(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.ValidationError})"> <summary> Adds elements to the ValidationErrors collection </summary> <param name="validationErrors">The values to add to the ValidationErrors collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.WithValidationWarnings(Amazon.DataPipeline.Model.ValidationWarning[])"> <summary> Adds elements to the ValidationWarnings collection </summary> <param name="validationWarnings">The values to add to the ValidationWarnings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.WithValidationWarnings(System.Collections.Generic.IEnumerable{Amazon.DataPipeline.Model.ValidationWarning})"> <summary> Adds elements to the ValidationWarnings collection </summary> <param name="validationWarnings">The values to add to the ValidationWarnings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.WithErrored(System.Boolean)"> <summary> Sets the Errored property </summary> <param name="errored">The value to set for the Errored property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.ValidationErrors"> <summary> Lists the validation errors that were found by <a>ValidatePipelineDefinition</a>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.ValidationWarnings"> <summary> Lists the validation warnings that were found by <a>ValidatePipelineDefinition</a>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.Errored"> <summary> If <c>True</c>, there were validation errors. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidationError"> <summary> <para>Defines a validation error returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.ValidationError.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidationError.WithErrors(System.String[])"> <summary> Adds elements to the Errors collection </summary> <param name="errors">The values to add to the Errors collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidationError.WithErrors(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Errors collection </summary> <param name="errors">The values to add to the Errors collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ValidationError.Id"> <summary> The identifier of the object that contains the validation error. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidationError.Errors"> <summary> A description of the validation error. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidationWarning"> <summary> <para>Defines a validation warning returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</para> </summary> </member> <member name="M:Amazon.DataPipeline.Model.ValidationWarning.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidationWarning.WithWarnings(System.String[])"> <summary> Adds elements to the Warnings collection </summary> <param name="warnings">The values to add to the Warnings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DataPipeline.Model.ValidationWarning.WithWarnings(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Warnings collection </summary> <param name="warnings">The values to add to the Warnings collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DataPipeline.Model.ValidationWarning.Id"> <summary> The identifier of the object that contains the validation warning. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 1024</description> </item> <item> <term>Pattern</term> <description>[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidationWarning.Warnings"> <summary> A description of the validation warning. </summary> </member> <member name="T:Amazon.DirectConnect.AmazonDirectConnect"> <summary> Interface for accessing AmazonDirectConnect. <para>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> <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.AmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"> <summary> <para>Accept ownership of a public virtual interface created by another customer.</para> <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="confirmPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the ConfirmPublicVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"/> </summary> <param name="confirmPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmPublicVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndConfirmPublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmPublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPublicVirtualInterface.</param> <returns>Returns a ConfirmPublicVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"> <summary> <para>Returns the list of Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</para> </summary> <param name="describeLocationsRequest">Container for the necessary parameters to execute the DescribeLocations service method on AmazonDirectConnect.</param> <returns>The response from the DescribeLocations service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLocations operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"/> </summary> <param name="describeLocationsRequest">Container for the necessary parameters to execute the DescribeLocations operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLocations operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDescribeLocations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLocations operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLocations.</param> <returns>Returns a DescribeLocationsResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeLocations"> <summary> <para>Returns the list of Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</para> </summary> <returns>The response from the DescribeLocations service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"> <summary> <para>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).</para> </summary> <param name="createPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the CreatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginCreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"/> </summary> <param name="createPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePrivateVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePrivateVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndCreatePrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePrivateVirtualInterface.</param> <returns>Returns a CreatePrivateVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"> <summary> <para>Deletes a virtual interface.</para> </summary> <param name="deleteVirtualInterfaceRequest">Container for the necessary parameters to execute the DeleteVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the DeleteVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"/> </summary> <param name="deleteVirtualInterfaceRequest">Container for the necessary parameters to execute the DeleteVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDeleteVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVirtualInterface.</param> <returns>Returns a DeleteVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"> <summary> <para>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).</para> </summary> <param name="createPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePublicVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the CreatePublicVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginCreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"/> </summary> <param name="createPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePublicVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePublicVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndCreatePublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePublicVirtualInterface.</param> <returns>Returns a CreatePublicVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"> <summary> <para>Creates a new interconnect between a Direct Connect partner's network and a specific AWS Direct Connect location.</para> <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 Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the 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 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 Direct Connect partner.</para> </summary> <param name="createInterconnectRequest">Container for the necessary parameters to execute the CreateInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the CreateInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginCreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"/> </summary> <param name="createInterconnectRequest">Container for the necessary parameters to execute the CreateInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndCreateInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInterconnect.</param> <returns>Returns a CreateInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"> <summary> <para>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> <para> A virtual interface (VLAN) transmits the traffic between the 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="describeVirtualInterfacesRequest">Container for the necessary parameters to execute the DescribeVirtualInterfaces service method on AmazonDirectConnect.</param> <returns>The response from the DescribeVirtualInterfaces service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualInterfaces operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"/> </summary> <param name="describeVirtualInterfacesRequest">Container for the necessary parameters to execute the DescribeVirtualInterfaces operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVirtualInterfaces operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDescribeVirtualInterfaces(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVirtualInterfaces operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualInterfaces.</param> <returns>Returns a DescribeVirtualInterfacesResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualInterfaces"> <summary> <para>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> <para> A virtual interface (VLAN) transmits the traffic between the 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 AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"> <summary> <para>Confirm the creation of a hosted connection on an interconnect.</para> <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="confirmConnectionRequest">Container for the necessary parameters to execute the ConfirmConnection service method on AmazonDirectConnect.</param> <returns>The response from the ConfirmConnection service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"/> </summary> <param name="confirmConnectionRequest">Container for the necessary parameters to execute the ConfirmConnection operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmConnection operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndConfirmConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmConnection.</param> <returns>Returns a ConfirmConnectionResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"> <summary> <para>Returns a list of interconnects owned by the AWS account.</para> <para>If an interconnect ID is provided, it will only return this particular interconnect.</para> </summary> <param name="describeInterconnectsRequest">Container for the necessary parameters to execute the DescribeInterconnects service method on AmazonDirectConnect.</param> <returns>The response from the DescribeInterconnects service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInterconnects operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"/> </summary> <param name="describeInterconnectsRequest">Container for the necessary parameters to execute the DescribeInterconnects operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInterconnects operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDescribeInterconnects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInterconnects operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInterconnects.</param> <returns>Returns a DescribeInterconnectsResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeInterconnects"> <summary> <para>Returns a list of interconnects owned by the AWS account.</para> <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 AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"> <summary> <para>Returns a list of virtual private gateways owned by the AWS account.</para> <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="describeVirtualGatewaysRequest">Container for the necessary parameters to execute the DescribeVirtualGateways service method on AmazonDirectConnect.</param> <returns>The response from the DescribeVirtualGateways service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualGateways operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"/> </summary> <param name="describeVirtualGatewaysRequest">Container for the necessary parameters to execute the DescribeVirtualGateways operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVirtualGateways operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDescribeVirtualGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVirtualGateways operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualGateways.</param> <returns>Returns a DescribeVirtualGatewaysResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualGateways"> <summary> <para>Returns a list of virtual private gateways owned by the AWS account.</para> <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 AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"> <summary> <para>Accept ownership of a private virtual interface created by another customer.</para> <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="confirmPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the ConfirmPrivateVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"/> </summary> <param name="confirmPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmPrivateVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndConfirmPrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmPrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPrivateVirtualInterface.</param> <returns>Returns a ConfirmPrivateVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"> <summary> <para>Displays all connections in this region.</para> <para>If a connection ID is provided, it will only return this particular connection.</para> </summary> <param name="describeConnectionsRequest">Container for the necessary parameters to execute the DescribeConnections service method on AmazonDirectConnect.</param> <returns>The response from the DescribeConnections service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnections operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"/> </summary> <param name="describeConnectionsRequest">Container for the necessary parameters to execute the DescribeConnections operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnections operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDescribeConnections(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConnections operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnections.</param> <returns>Returns a DescribeConnectionsResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnections"> <summary> <para>Displays all connections in this region.</para> <para>If a connection ID is provided, it will only return this particular connection.</para> </summary> <returns>The response from the DescribeConnections service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"> <summary> <para>Provisions a public virtual interface to be owned by a different customer.</para> <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="allocatePublicVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePublicVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the AllocatePublicVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginAllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"/> </summary> <param name="allocatePublicVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePublicVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocatePublicVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndAllocatePublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePublicVirtualInterface.</param> <returns>Returns a AllocatePublicVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"> <summary> <para>Provisions a private virtual interface to be owned by a different customer.</para> <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="allocatePrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the AllocatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginAllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"/> </summary> <param name="allocatePrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocatePrivateVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndAllocatePrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePrivateVirtualInterface.</param> <returns>Returns a AllocatePrivateVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"> <summary> <para>Deletes the connection.</para> <para>Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You separately need to cancel any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location with the providers of those services.</para> </summary> <param name="deleteConnectionRequest">Container for the necessary parameters to execute the DeleteConnection service method on AmazonDirectConnect.</param> <returns>The response from the DeleteConnection service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"/> </summary> <param name="deleteConnectionRequest">Container for the necessary parameters to execute the DeleteConnection operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteConnection operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDeleteConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConnection.</param> <returns>Returns a DeleteConnectionResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"> <summary> <para>Return a list of connections that have been provisioned on the given interconnect.</para> </summary> <param name="describeConnectionsOnInterconnectRequest">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the DescribeConnectionsOnInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"/> </summary> <param name="describeConnectionsOnInterconnectRequest">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnectionsOnInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDescribeConnectionsOnInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConnectionsOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnectionsOnInterconnect.</param> <returns>Returns a DescribeConnectionsOnInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"> <summary> <para>Creates a hosted connection on an interconnect.</para> <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="allocateConnectionOnInterconnectRequest">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the AllocateConnectionOnInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginAllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"/> </summary> <param name="allocateConnectionOnInterconnectRequest">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocateConnectionOnInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndAllocateConnectionOnInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocateConnectionOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocateConnectionOnInterconnect.</param> <returns>Returns a AllocateConnectionOnInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"> <summary> <para>Creates a new connection between the customer network and a specific AWS Direct Connect location.</para> <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. A 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="createConnectionRequest">Container for the necessary parameters to execute the CreateConnection service method on AmazonDirectConnect.</param> <returns>The response from the CreateConnection service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginCreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"/> </summary> <param name="createConnectionRequest">Container for the necessary parameters to execute the CreateConnection operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateConnection operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndCreateConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateConnection.</param> <returns>Returns a CreateConnectionResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"> <summary> <para>Deletes the specified interconnect.</para> </summary> <param name="deleteInterconnectRequest">Container for the necessary parameters to execute the DeleteInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the DeleteInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.BeginDeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"/> </summary> <param name="deleteInterconnectRequest">Container for the necessary parameters to execute the DeleteInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnect.EndDeleteInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInterconnect.</param> <returns>Returns a DeleteInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="T:Amazon.DirectConnect.AmazonDirectConnectClient"> <summary> Implementation for accessing AmazonDirectConnect. <para>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> <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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDirectConnect 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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 AmazonDirectConnectConfig Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"> <summary> <para>Accept ownership of a public virtual interface created by another customer.</para> <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="confirmPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the ConfirmPublicVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"/> </summary> <param name="confirmPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmPublicVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndConfirmPublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmPublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPublicVirtualInterface.</param> <returns>Returns a ConfirmPublicVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"> <summary> <para>Returns the list of Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</para> </summary> <param name="describeLocationsRequest">Container for the necessary parameters to execute the DescribeLocations service method on AmazonDirectConnect.</param> <returns>The response from the DescribeLocations service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLocations operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"/> </summary> <param name="describeLocationsRequest">Container for the necessary parameters to execute the DescribeLocations operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLocations operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDescribeLocations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLocations operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLocations.</param> <returns>Returns a DescribeLocationsResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeLocations"> <summary> <para>Returns the list of Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</para> </summary> <returns>The response from the DescribeLocations service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"> <summary> <para>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).</para> </summary> <param name="createPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the CreatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"/> </summary> <param name="createPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePrivateVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePrivateVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndCreatePrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePrivateVirtualInterface.</param> <returns>Returns a CreatePrivateVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"> <summary> <para>Deletes a virtual interface.</para> </summary> <param name="deleteVirtualInterfaceRequest">Container for the necessary parameters to execute the DeleteVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the DeleteVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"/> </summary> <param name="deleteVirtualInterfaceRequest">Container for the necessary parameters to execute the DeleteVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDeleteVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVirtualInterface.</param> <returns>Returns a DeleteVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"> <summary> <para>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).</para> </summary> <param name="createPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePublicVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the CreatePublicVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"/> </summary> <param name="createPublicVirtualInterfaceRequest">Container for the necessary parameters to execute the CreatePublicVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePublicVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndCreatePublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePublicVirtualInterface.</param> <returns>Returns a CreatePublicVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"> <summary> <para>Creates a new interconnect between a Direct Connect partner's network and a specific AWS Direct Connect location.</para> <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 Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the 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 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 Direct Connect partner.</para> </summary> <param name="createInterconnectRequest">Container for the necessary parameters to execute the CreateInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the CreateInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"/> </summary> <param name="createInterconnectRequest">Container for the necessary parameters to execute the CreateInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndCreateInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInterconnect.</param> <returns>Returns a CreateInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"> <summary> <para>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> <para> A virtual interface (VLAN) transmits the traffic between the 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="describeVirtualInterfacesRequest">Container for the necessary parameters to execute the DescribeVirtualInterfaces service method on AmazonDirectConnect.</param> <returns>The response from the DescribeVirtualInterfaces service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualInterfaces operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"/> </summary> <param name="describeVirtualInterfacesRequest">Container for the necessary parameters to execute the DescribeVirtualInterfaces operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVirtualInterfaces operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDescribeVirtualInterfaces(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVirtualInterfaces operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualInterfaces.</param> <returns>Returns a DescribeVirtualInterfacesResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualInterfaces"> <summary> <para>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> <para> A virtual interface (VLAN) transmits the traffic between the 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 AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"> <summary> <para>Confirm the creation of a hosted connection on an interconnect.</para> <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="confirmConnectionRequest">Container for the necessary parameters to execute the ConfirmConnection service method on AmazonDirectConnect.</param> <returns>The response from the ConfirmConnection service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"/> </summary> <param name="confirmConnectionRequest">Container for the necessary parameters to execute the ConfirmConnection operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmConnection operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndConfirmConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmConnection.</param> <returns>Returns a ConfirmConnectionResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"> <summary> <para>Returns a list of interconnects owned by the AWS account.</para> <para>If an interconnect ID is provided, it will only return this particular interconnect.</para> </summary> <param name="describeInterconnectsRequest">Container for the necessary parameters to execute the DescribeInterconnects service method on AmazonDirectConnect.</param> <returns>The response from the DescribeInterconnects service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInterconnects operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"/> </summary> <param name="describeInterconnectsRequest">Container for the necessary parameters to execute the DescribeInterconnects operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInterconnects operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDescribeInterconnects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInterconnects operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInterconnects.</param> <returns>Returns a DescribeInterconnectsResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeInterconnects"> <summary> <para>Returns a list of interconnects owned by the AWS account.</para> <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 AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"> <summary> <para>Returns a list of virtual private gateways owned by the AWS account.</para> <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="describeVirtualGatewaysRequest">Container for the necessary parameters to execute the DescribeVirtualGateways service method on AmazonDirectConnect.</param> <returns>The response from the DescribeVirtualGateways service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualGateways operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"/> </summary> <param name="describeVirtualGatewaysRequest">Container for the necessary parameters to execute the DescribeVirtualGateways operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVirtualGateways operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDescribeVirtualGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVirtualGateways operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualGateways.</param> <returns>Returns a DescribeVirtualGatewaysResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualGateways"> <summary> <para>Returns a list of virtual private gateways owned by the AWS account.</para> <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 AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"> <summary> <para>Accept ownership of a private virtual interface created by another customer.</para> <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="confirmPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the ConfirmPrivateVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"/> </summary> <param name="confirmPrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmPrivateVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndConfirmPrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmPrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPrivateVirtualInterface.</param> <returns>Returns a ConfirmPrivateVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"> <summary> <para>Displays all connections in this region.</para> <para>If a connection ID is provided, it will only return this particular connection.</para> </summary> <param name="describeConnectionsRequest">Container for the necessary parameters to execute the DescribeConnections service method on AmazonDirectConnect.</param> <returns>The response from the DescribeConnections service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnections operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"/> </summary> <param name="describeConnectionsRequest">Container for the necessary parameters to execute the DescribeConnections operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnections operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDescribeConnections(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConnections operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnections.</param> <returns>Returns a DescribeConnectionsResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnections"> <summary> <para>Displays all connections in this region.</para> <para>If a connection ID is provided, it will only return this particular connection.</para> </summary> <returns>The response from the DescribeConnections service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"> <summary> <para>Provisions a public virtual interface to be owned by a different customer.</para> <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="allocatePublicVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePublicVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the AllocatePublicVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginAllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"/> </summary> <param name="allocatePublicVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePublicVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocatePublicVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndAllocatePublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocatePublicVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePublicVirtualInterface.</param> <returns>Returns a AllocatePublicVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"> <summary> <para>Provisions a private virtual interface to be owned by a different customer.</para> <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="allocatePrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface service method on AmazonDirectConnect.</param> <returns>The response from the AllocatePrivateVirtualInterface service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginAllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"/> </summary> <param name="allocatePrivateVirtualInterfaceRequest">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocatePrivateVirtualInterface operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndAllocatePrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocatePrivateVirtualInterface operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePrivateVirtualInterface.</param> <returns>Returns a AllocatePrivateVirtualInterfaceResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"> <summary> <para>Deletes the connection.</para> <para>Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You separately need to cancel any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location with the providers of those services.</para> </summary> <param name="deleteConnectionRequest">Container for the necessary parameters to execute the DeleteConnection service method on AmazonDirectConnect.</param> <returns>The response from the DeleteConnection service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"/> </summary> <param name="deleteConnectionRequest">Container for the necessary parameters to execute the DeleteConnection operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteConnection operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDeleteConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConnection.</param> <returns>Returns a DeleteConnectionResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"> <summary> <para>Return a list of connections that have been provisioned on the given interconnect.</para> </summary> <param name="describeConnectionsOnInterconnectRequest">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the DescribeConnectionsOnInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"/> </summary> <param name="describeConnectionsOnInterconnectRequest">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnectionsOnInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDescribeConnectionsOnInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConnectionsOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnectionsOnInterconnect.</param> <returns>Returns a DescribeConnectionsOnInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"> <summary> <para>Creates a hosted connection on an interconnect.</para> <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="allocateConnectionOnInterconnectRequest">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the AllocateConnectionOnInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginAllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"/> </summary> <param name="allocateConnectionOnInterconnectRequest">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocateConnectionOnInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndAllocateConnectionOnInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocateConnectionOnInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocateConnectionOnInterconnect.</param> <returns>Returns a AllocateConnectionOnInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"> <summary> <para>Creates a new connection between the customer network and a specific AWS Direct Connect location.</para> <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. A 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="createConnectionRequest">Container for the necessary parameters to execute the CreateConnection service method on AmazonDirectConnect.</param> <returns>The response from the CreateConnection service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"/> </summary> <param name="createConnectionRequest">Container for the necessary parameters to execute the CreateConnection operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateConnection operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndCreateConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateConnection operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateConnection.</param> <returns>Returns a CreateConnectionResult from AmazonDirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"> <summary> <para>Deletes the specified interconnect.</para> </summary> <param name="deleteInterconnectRequest">Container for the necessary parameters to execute the DeleteInterconnect service method on AmazonDirectConnect.</param> <returns>The response from the DeleteInterconnect service method, as returned by AmazonDirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"/> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"/> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"/> </summary> <param name="deleteInterconnectRequest">Container for the necessary parameters to execute the DeleteInterconnect operation on AmazonDirectConnect.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteInterconnect operation.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.EndDeleteInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteInterconnect operation. <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInterconnect.</param> <returns>Returns a DeleteInterconnectResult from AmazonDirectConnect.</returns> </member> <member name="T:Amazon.DirectConnect.AmazonDirectConnectConfig"> <summary> Configuration for accessing service </summary> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.DirectConnect.AmazonDirectConnectConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.DirectConnect.AmazonDirectConnectConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest"> <summary> Container for the parameters to the AllocateConnectionOnInterconnect operation. <para>Creates a hosted connection on an interconnect.</para> <para>Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.WithConnectionName(System.String)"> <summary> Sets the ConnectionName property </summary> <param name="connectionName">The value to set for the ConnectionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.WithInterconnectId(System.String)"> <summary> Sets the InterconnectId property </summary> <param name="interconnectId">The value to set for the InterconnectId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.ConnectionName"> <summary> Name of the provisioned connection. Example: "<i>500M Connection to AWS</i>" Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.OwnerAccount"> <summary> Numeric account Id of the customer for whom the connection will be provisioned. Example: 123443215678 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.InterconnectId"> <summary> ID of the interconnect on which the connection will be provisioned. Example: dxcon-456abc78 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.Vlan"> <summary> The dedicated VLAN provisioned to the connection. Example: 101 Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResponse"> <summary> Returns information about the AllocateConnectionOnInterconnectResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResponse.AllocateConnectionOnInterconnectResult"> <summary> Gets and sets the AllocateConnectionOnInterconnectResult property. A connection represents the physical network connection between the Direct Connect location and the customer. </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult"> <summary> <para>A connection represents the physical network connection between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithConnectionName(System.String)"> <summary> Sets the ConnectionName property </summary> <param name="connectionName">The value to set for the ConnectionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithConnectionState(System.String)"> <summary> Sets the ConnectionState property </summary> <param name="connectionState">The value to set for the ConnectionState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithRegion(System.String)"> <summary> Sets the Region property </summary> <param name="region">The value to set for the Region property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.WithPartnerName(System.String)"> <summary> Sets the PartnerName property </summary> <param name="partnerName">The value to set for the PartnerName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.ConnectionName"> <summary> The name of the connection. Example: "<i>1G Connection to AWS</i>" Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.ConnectionState"> <summary> State of the connection. <ul> <li><b>Ordering</b>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</li> <li><b>Requested</b>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The connection has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the connection is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The connection has been deleted.</li> <li><b>Rejected</b>: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ordering, requested, pending, available, down, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Region"> <summary> The AWS region where the connection is located. Example: us-east-1 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest"> <summary> Container for the parameters to the AllocatePrivateVirtualInterface operation. <para>Provisions a private virtual interface to be owned by a different customer.</para> <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> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.WithNewPrivateVirtualInterfaceAllocation(Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation)"> <summary> Sets the NewPrivateVirtualInterfaceAllocation property </summary> <param name="newPrivateVirtualInterfaceAllocation">The value to set for the NewPrivateVirtualInterfaceAllocation property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.ConnectionId"> <summary> The connection ID on which the private virtual interface is provisioned. Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.OwnerAccount"> <summary> The AWS account that will own the new private virtual interface. Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.NewPrivateVirtualInterfaceAllocation"> <summary> Detailed information of the private virtual interface to be provisioned. Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResponse"> <summary> Returns information about the AllocatePrivateVirtualInterfaceResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResponse.AllocatePrivateVirtualInterfaceResult"> <summary> Gets and sets the AllocatePrivateVirtualInterfaceResult property. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer. </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult"> <summary> <para>A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithVirtualInterfaceType(System.String)"> <summary> Sets the VirtualInterfaceType property </summary> <param name="virtualInterfaceType">The value to set for the VirtualInterfaceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithCustomerRouterConfig(System.String)"> <summary> Sets the CustomerRouterConfig property </summary> <param name="customerRouterConfig">The value to set for the CustomerRouterConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithRouteFilterPrefixes(Amazon.DirectConnect.Model.RouteFilterPrefix[])"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.WithRouteFilterPrefixes(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.RouteFilterPrefix})"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceType"> <summary> The type of virtual interface Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.) </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.CustomerRouterConfig"> <summary> Information for generating the customer router configuration. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualGatewayId"> <summary> The ID of the virtual private gateway to a VPC. Only applies to private virtual interfaces. Example: vgw-123er56 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.RouteFilterPrefixes"> <summary> A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface). </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest"> <summary> Container for the parameters to the AllocatePublicVirtualInterface operation. <para>Provisions a public virtual interface to be owned by a different customer.</para> <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> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.WithNewPublicVirtualInterfaceAllocation(Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation)"> <summary> Sets the NewPublicVirtualInterfaceAllocation property </summary> <param name="newPublicVirtualInterfaceAllocation">The value to set for the NewPublicVirtualInterfaceAllocation property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.ConnectionId"> <summary> The connection ID on which the public virtual interface is provisioned. Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.OwnerAccount"> <summary> The AWS account that will own the new public virtual interface. Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.NewPublicVirtualInterfaceAllocation"> <summary> Detailed information of the public virtual interface to be provisioned. Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResponse"> <summary> Returns information about the AllocatePublicVirtualInterfaceResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResponse.AllocatePublicVirtualInterfaceResult"> <summary> Gets and sets the AllocatePublicVirtualInterfaceResult property. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer. </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult"> <summary> <para>A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithVirtualInterfaceType(System.String)"> <summary> Sets the VirtualInterfaceType property </summary> <param name="virtualInterfaceType">The value to set for the VirtualInterfaceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithCustomerRouterConfig(System.String)"> <summary> Sets the CustomerRouterConfig property </summary> <param name="customerRouterConfig">The value to set for the CustomerRouterConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithRouteFilterPrefixes(Amazon.DirectConnect.Model.RouteFilterPrefix[])"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.WithRouteFilterPrefixes(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.RouteFilterPrefix})"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceType"> <summary> The type of virtual interface Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.) </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.CustomerRouterConfig"> <summary> Information for generating the customer router configuration. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualGatewayId"> <summary> The ID of the virtual private gateway to a VPC. Only applies to private virtual interfaces. Example: vgw-123er56 </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.RouteFilterPrefixes"> <summary> A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface). </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmConnectionRequest"> <summary> Container for the parameters to the ConfirmConnection operation. <para>Confirm the creation of a hosted connection on an interconnect.</para> <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> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.ConfirmConnectionRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmConnectionRequest.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmConnectionResponse"> <summary> Returns information about the ConfirmConnectionResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmConnectionResponse.ConfirmConnectionResult"> <summary> Gets and sets the ConfirmConnectionResult property. The response received when ConfirmConnection is called. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmConnectionResult"> <summary> <para>The response received when ConfirmConnection is called.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.ConfirmConnectionResult.WithConnectionState(System.String)"> <summary> Sets the ConnectionState property </summary> <param name="connectionState">The value to set for the ConnectionState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmConnectionResult.ConnectionState"> <summary> State of the connection. <ul> <li><b>Ordering</b>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</li> <li><b>Requested</b>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The connection has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the connection is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The connection has been deleted.</li> <li><b>Rejected</b>: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ordering, requested, pending, available, down, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest"> <summary> Container for the parameters to the ConfirmPrivateVirtualInterface operation. <para>Accept ownership of a private virtual interface created by another customer.</para> <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> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest.VirtualGatewayId"> <summary> ID of the virtual private gateway that will be attached to the virtual interface. A virtual private gateway can be managed via the 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. Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResponse"> <summary> Returns information about the ConfirmPrivateVirtualInterfaceResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResponse.ConfirmPrivateVirtualInterfaceResult"> <summary> Gets and sets the ConfirmPrivateVirtualInterfaceResult property. The response received when ConfirmPrivateVirtualInterface is called. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResult"> <summary> <para>The response received when ConfirmPrivateVirtualInterface is called.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResult.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResult.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest"> <summary> Container for the parameters to the ConfirmPublicVirtualInterface operation. <para>Accept ownership of a public virtual interface created by another customer.</para> <para>After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResponse"> <summary> Returns information about the ConfirmPublicVirtualInterfaceResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResponse.ConfirmPublicVirtualInterfaceResult"> <summary> Gets and sets the ConfirmPublicVirtualInterfaceResult property. The response received when ConfirmPublicVirtualInterface is called. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResult"> <summary> <para>The response received when ConfirmPublicVirtualInterface is called.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResult.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResult.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.Connection"> <summary> <para>A connection represents the physical network connection between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithConnectionName(System.String)"> <summary> Sets the ConnectionName property </summary> <param name="connectionName">The value to set for the ConnectionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithConnectionState(System.String)"> <summary> Sets the ConnectionState property </summary> <param name="connectionState">The value to set for the ConnectionState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithRegion(System.String)"> <summary> Sets the Region property </summary> <param name="region">The value to set for the Region property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Connection.WithPartnerName(System.String)"> <summary> Sets the PartnerName property </summary> <param name="partnerName">The value to set for the PartnerName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.Connection.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.ConnectionName"> <summary> The name of the connection. Example: "<i>1G Connection to AWS</i>" Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.ConnectionState"> <summary> State of the connection. <ul> <li><b>Ordering</b>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</li> <li><b>Requested</b>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The connection has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the connection is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The connection has been deleted.</li> <li><b>Rejected</b>: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ordering, requested, pending, available, down, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Region"> <summary> The AWS region where the connection is located. Example: us-east-1 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateConnectionRequest"> <summary> Container for the parameters to the CreateConnection operation. <para>Creates a new connection between the customer network and a specific AWS Direct Connect location.</para> <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. A 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> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionRequest.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionRequest.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionRequest.WithConnectionName(System.String)"> <summary> Sets the ConnectionName property </summary> <param name="connectionName">The value to set for the ConnectionName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionRequest.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionRequest.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionRequest.ConnectionName"> <summary> The name of the connection. Example: "<i>1G Connection to AWS</i>" Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateConnectionResponse"> <summary> Returns information about the CreateConnectionResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResponse.CreateConnectionResult"> <summary> Gets and sets the CreateConnectionResult property. A connection represents the physical network connection between the Direct Connect location and the customer. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateConnectionResult"> <summary> <para>A connection represents the physical network connection between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithConnectionName(System.String)"> <summary> Sets the ConnectionName property </summary> <param name="connectionName">The value to set for the ConnectionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithConnectionState(System.String)"> <summary> Sets the ConnectionState property </summary> <param name="connectionState">The value to set for the ConnectionState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithRegion(System.String)"> <summary> Sets the Region property </summary> <param name="region">The value to set for the Region property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateConnectionResult.WithPartnerName(System.String)"> <summary> Sets the PartnerName property </summary> <param name="partnerName">The value to set for the PartnerName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.ConnectionName"> <summary> The name of the connection. Example: "<i>1G Connection to AWS</i>" Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.ConnectionState"> <summary> State of the connection. <ul> <li><b>Ordering</b>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</li> <li><b>Requested</b>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The connection has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the connection is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The connection has been deleted.</li> <li><b>Rejected</b>: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ordering, requested, pending, available, down, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Region"> <summary> The AWS region where the connection is located. Example: us-east-1 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateInterconnectRequest"> <summary> Container for the parameters to the CreateInterconnect operation. <para>Creates a new interconnect between a Direct Connect partner's network and a specific AWS Direct Connect location.</para> <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 Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the 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 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 Direct Connect partner.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectRequest.WithInterconnectName(System.String)"> <summary> Sets the InterconnectName property </summary> <param name="interconnectName">The value to set for the InterconnectName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectRequest.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectRequest.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectRequest.InterconnectName"> <summary> The name of the interconnect. Example: "<i>1G Interconnect to AWS</i>" Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectRequest.Bandwidth"> <summary> The port bandwidth Example: 1Gbps Default: None Available values: 1Gbps,10Gbps </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectRequest.Location"> <summary> Where the interconnect is located Example: EqSV5 Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateInterconnectResponse"> <summary> Returns information about the CreateInterconnectResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResponse.CreateInterconnectResult"> <summary> Gets and sets the CreateInterconnectResult property. An interconnect is a connection that can host other connections. Like a standard Direct Connect connection, an interconnect represents the physical connection between a Direct Connect partner's network and a specific Direct Connect location. A Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services. The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateInterconnectResult"> <summary> <para>An interconnect is a connection that can host other connections.</para> <para>Like a standard Direct Connect connection, an interconnect represents the physical connection between a Direct Connect partner's network and a specific Direct Connect location. A Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.</para> <para>The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectResult.WithInterconnectId(System.String)"> <summary> Sets the InterconnectId property </summary> <param name="interconnectId">The value to set for the InterconnectId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectResult.WithInterconnectName(System.String)"> <summary> Sets the InterconnectName property </summary> <param name="interconnectName">The value to set for the InterconnectName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectResult.WithInterconnectState(System.String)"> <summary> Sets the InterconnectState property </summary> <param name="interconnectState">The value to set for the InterconnectState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectResult.WithRegion(System.String)"> <summary> Sets the Region property </summary> <param name="region">The value to set for the Region property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreateInterconnectResult.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.InterconnectId"> <summary> The ID of the interconnect. Example: dxcon-abc123 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.InterconnectName"> <summary> The name of the interconnect. Example: "<i>1G Interconnect to AWS</i>" </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.InterconnectState"> <summary> State of the interconnect. <ul> <li><b>Requested</b>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The interconnect has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the interconnect is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The interconnect has been deleted.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>requested, pending, available, down, deleting, deleted</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.Region"> <summary> The AWS region where the connection is located. Example: us-east-1 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest"> <summary> Container for the parameters to the CreatePrivateVirtualInterface operation. <para>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).</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest.WithNewPrivateVirtualInterface(Amazon.DirectConnect.Model.NewPrivateVirtualInterface)"> <summary> Sets the NewPrivateVirtualInterface property </summary> <param name="newPrivateVirtualInterface">The value to set for the NewPrivateVirtualInterface property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest.NewPrivateVirtualInterface"> <summary> Detailed information of the private virtual interface to be created. Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse"> <summary> Returns information about the CreatePrivateVirtualInterfaceResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse.CreatePrivateVirtualInterfaceResult"> <summary> Gets and sets the CreatePrivateVirtualInterfaceResult property. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult"> <summary> <para>A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithVirtualInterfaceType(System.String)"> <summary> Sets the VirtualInterfaceType property </summary> <param name="virtualInterfaceType">The value to set for the VirtualInterfaceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithCustomerRouterConfig(System.String)"> <summary> Sets the CustomerRouterConfig property </summary> <param name="customerRouterConfig">The value to set for the CustomerRouterConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithRouteFilterPrefixes(Amazon.DirectConnect.Model.RouteFilterPrefix[])"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.WithRouteFilterPrefixes(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.RouteFilterPrefix})"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceType"> <summary> The type of virtual interface Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.) </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.CustomerRouterConfig"> <summary> Information for generating the customer router configuration. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualGatewayId"> <summary> The ID of the virtual private gateway to a VPC. Only applies to private virtual interfaces. Example: vgw-123er56 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.RouteFilterPrefixes"> <summary> A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface). </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest"> <summary> Container for the parameters to the CreatePublicVirtualInterface operation. <para>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).</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest.WithNewPublicVirtualInterface(Amazon.DirectConnect.Model.NewPublicVirtualInterface)"> <summary> Sets the NewPublicVirtualInterface property </summary> <param name="newPublicVirtualInterface">The value to set for the NewPublicVirtualInterface property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest.NewPublicVirtualInterface"> <summary> Detailed information of the public virtual interface to be created. Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResponse"> <summary> Returns information about the CreatePublicVirtualInterfaceResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResponse.CreatePublicVirtualInterfaceResult"> <summary> Gets and sets the CreatePublicVirtualInterfaceResult property. A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult"> <summary> <para>A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithVirtualInterfaceType(System.String)"> <summary> Sets the VirtualInterfaceType property </summary> <param name="virtualInterfaceType">The value to set for the VirtualInterfaceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithCustomerRouterConfig(System.String)"> <summary> Sets the CustomerRouterConfig property </summary> <param name="customerRouterConfig">The value to set for the CustomerRouterConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithRouteFilterPrefixes(Amazon.DirectConnect.Model.RouteFilterPrefix[])"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.WithRouteFilterPrefixes(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.RouteFilterPrefix})"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceType"> <summary> The type of virtual interface Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.) </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.CustomerRouterConfig"> <summary> Information for generating the customer router configuration. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualGatewayId"> <summary> The ID of the virtual private gateway to a VPC. Only applies to private virtual interfaces. Example: vgw-123er56 </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.RouteFilterPrefixes"> <summary> A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface). </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteConnectionRequest"> <summary> Container for the parameters to the DeleteConnection operation. <para>Deletes the connection.</para> <para>Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You separately need to cancel any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location with the providers of those services.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionRequest.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteConnectionResponse"> <summary> Returns information about the DeleteConnectionResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResponse.DeleteConnectionResult"> <summary> Gets and sets the DeleteConnectionResult property. A connection represents the physical network connection between the Direct Connect location and the customer. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteConnectionResult"> <summary> <para>A connection represents the physical network connection between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithConnectionName(System.String)"> <summary> Sets the ConnectionName property </summary> <param name="connectionName">The value to set for the ConnectionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithConnectionState(System.String)"> <summary> Sets the ConnectionState property </summary> <param name="connectionState">The value to set for the ConnectionState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithRegion(System.String)"> <summary> Sets the Region property </summary> <param name="region">The value to set for the Region property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DeleteConnectionResult.WithPartnerName(System.String)"> <summary> Sets the PartnerName property </summary> <param name="partnerName">The value to set for the PartnerName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.ConnectionName"> <summary> The name of the connection. Example: "<i>1G Connection to AWS</i>" Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.ConnectionState"> <summary> State of the connection. <ul> <li><b>Ordering</b>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</li> <li><b>Requested</b>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The connection has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the connection is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The connection has been deleted.</li> <li><b>Rejected</b>: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ordering, requested, pending, available, down, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Region"> <summary> The AWS region where the connection is located. Example: us-east-1 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteInterconnectRequest"> <summary> Container for the parameters to the DeleteInterconnect operation. <para>Deletes the specified interconnect.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.DeleteInterconnectRequest.WithInterconnectId(System.String)"> <summary> Sets the InterconnectId property </summary> <param name="interconnectId">The value to set for the InterconnectId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DeleteInterconnectRequest.InterconnectId"> <summary> The ID of the interconnect. Example: dxcon-abc123 </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteInterconnectResponse"> <summary> Returns information about the DeleteInterconnectResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteInterconnectResponse.DeleteInterconnectResult"> <summary> Gets and sets the DeleteInterconnectResult property. The response received when DeleteInterconnect is called. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteInterconnectResult"> <summary> <para>The response received when DeleteInterconnect is called.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DeleteInterconnectResult.WithInterconnectState(System.String)"> <summary> Sets the InterconnectState property </summary> <param name="interconnectState">The value to set for the InterconnectState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DeleteInterconnectResult.InterconnectState"> <summary> State of the interconnect. <ul> <li><b>Requested</b>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The interconnect has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the interconnect is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The interconnect has been deleted.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>requested, pending, available, down, deleting, deleted</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest"> <summary> Container for the parameters to the DeleteVirtualInterface operation. <para>Deletes a virtual interface.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResponse"> <summary> Returns information about the DeleteVirtualInterfaceResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResponse.DeleteVirtualInterfaceResult"> <summary> Gets and sets the DeleteVirtualInterfaceResult property. The response received when DeleteVirtualInterface is called. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResult"> <summary> <para>The response received when DeleteVirtualInterface is called.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResult.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResult.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest"> <summary> Container for the parameters to the DescribeConnectionsOnInterconnect operation. <para>Return a list of connections that have been provisioned on the given interconnect.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest.WithInterconnectId(System.String)"> <summary> Sets the InterconnectId property </summary> <param name="interconnectId">The value to set for the InterconnectId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest.InterconnectId"> <summary> ID of the interconnect on which a list of connection is provisioned. Example: dxcon-abc123 Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResponse"> <summary> Returns information about the DescribeConnectionsOnInterconnectResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResponse.DescribeConnectionsOnInterconnectResult"> <summary> Gets and sets the DescribeConnectionsOnInterconnectResult property. A structure containing a list of connections. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResult"> <summary> <para>A structure containing a list of connections.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResult.WithConnections(Amazon.DirectConnect.Model.Connection[])"> <summary> Adds elements to the Connections collection </summary> <param name="connections">The values to add to the Connections collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResult.WithConnections(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.Connection})"> <summary> Adds elements to the Connections collection </summary> <param name="connections">The values to add to the Connections collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResult.Connections"> <summary> A list of connections. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsRequest"> <summary> Container for the parameters to the DescribeConnections operation. <para>Displays all connections in this region.</para> <para>If a connection ID is provided, it will only return this particular connection.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.DescribeConnectionsRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsRequest.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsResponse"> <summary> Returns information about the DescribeConnectionsResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsResponse.DescribeConnectionsResult"> <summary> Gets and sets the DescribeConnectionsResult property. A structure containing a list of connections. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsResult"> <summary> <para>A structure containing a list of connections.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DescribeConnectionsResult.WithConnections(Amazon.DirectConnect.Model.Connection[])"> <summary> Adds elements to the Connections collection </summary> <param name="connections">The values to add to the Connections collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DescribeConnectionsResult.WithConnections(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.Connection})"> <summary> Adds elements to the Connections collection </summary> <param name="connections">The values to add to the Connections collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsResult.Connections"> <summary> A list of connections. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeInterconnectsRequest"> <summary> Container for the parameters to the DescribeInterconnects operation. <para>Returns a list of interconnects owned by the AWS account.</para> <para>If an interconnect ID is provided, it will only return this particular interconnect.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.DescribeInterconnectsRequest.WithInterconnectId(System.String)"> <summary> Sets the InterconnectId property </summary> <param name="interconnectId">The value to set for the InterconnectId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeInterconnectsRequest.InterconnectId"> <summary> The ID of the interconnect. Example: dxcon-abc123 </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeInterconnectsResponse"> <summary> Returns information about the DescribeInterconnectsResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeInterconnectsResponse.DescribeInterconnectsResult"> <summary> Gets and sets the DescribeInterconnectsResult property. A structure containing a list of interconnects. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeInterconnectsResult"> <summary> <para>A structure containing a list of interconnects.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DescribeInterconnectsResult.WithInterconnects(Amazon.DirectConnect.Model.Interconnect[])"> <summary> Adds elements to the Interconnects collection </summary> <param name="interconnects">The values to add to the Interconnects collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DescribeInterconnectsResult.WithInterconnects(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.Interconnect})"> <summary> Adds elements to the Interconnects collection </summary> <param name="interconnects">The values to add to the Interconnects collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeInterconnectsResult.Interconnects"> <summary> A list of interconnects. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeLocationsRequest"> <summary> Container for the parameters to the DescribeLocations operation. <para>Returns the list of Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</para> </summary> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"/> </member> <member name="T:Amazon.DirectConnect.Model.DescribeLocationsResponse"> <summary> Returns information about the DescribeLocationsResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeLocationsResponse.DescribeLocationsResult"> <summary> Gets and sets the DescribeLocationsResult property. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeLocationsResult"> <summary>Describe Locations Result </summary> </member> <member name="M:Amazon.DirectConnect.Model.DescribeLocationsResult.WithLocations(Amazon.DirectConnect.Model.Location[])"> <summary> Adds elements to the Locations collection </summary> <param name="locations">The values to add to the Locations collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DescribeLocationsResult.WithLocations(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.Location})"> <summary> Adds elements to the Locations collection </summary> <param name="locations">The values to add to the Locations collection </param> <returns>this instance</returns> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest"> <summary> Container for the parameters to the DescribeVirtualGateways operation. <para>Returns a list of virtual private gateways owned by the AWS account.</para> <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> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"/> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResponse"> <summary> Returns information about the DescribeVirtualGatewaysResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResponse.DescribeVirtualGatewaysResult"> <summary> Gets and sets the DescribeVirtualGatewaysResult property. A structure containing a list of virtual private gateways. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResult"> <summary> <para>A structure containing a list of virtual private gateways.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResult.WithVirtualGateways(Amazon.DirectConnect.Model.VirtualGateway[])"> <summary> Adds elements to the VirtualGateways collection </summary> <param name="virtualGateways">The values to add to the VirtualGateways collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResult.WithVirtualGateways(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.VirtualGateway})"> <summary> Adds elements to the VirtualGateways collection </summary> <param name="virtualGateways">The values to add to the VirtualGateways collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResult.VirtualGateways"> <summary> A list of virtual private gateways. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest"> <summary> Container for the parameters to the DescribeVirtualInterfaces operation. <para>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> <para> A virtual interface (VLAN) transmits the traffic between the 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> <seealso cref="M:Amazon.DirectConnect.AmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"/> </member> <member name="M:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResponse"> <summary> Returns information about the DescribeVirtualInterfacesResult response and response metadata. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResponse.DescribeVirtualInterfacesResult"> <summary> Gets and sets the DescribeVirtualInterfacesResult property. A structure containing a list of virtual interfaces. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResult"> <summary> <para>A structure containing a list of virtual interfaces.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResult.WithVirtualInterfaces(Amazon.DirectConnect.Model.VirtualInterface[])"> <summary> Adds elements to the VirtualInterfaces collection </summary> <param name="virtualInterfaces">The values to add to the VirtualInterfaces collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResult.WithVirtualInterfaces(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.VirtualInterface})"> <summary> Adds elements to the VirtualInterfaces collection </summary> <param name="virtualInterfaces">The values to add to the VirtualInterfaces collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResult.VirtualInterfaces"> <summary> A list of virtual interfaces. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DirectConnectClientException"> <summary> AmazonDirectConnect exception </summary> </member> <member name="M:Amazon.DirectConnect.Model.DirectConnectClientException.#ctor(System.String)"> <summary> Constructs a new DirectConnectClientException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectConnect.Model.DirectConnectServerException"> <summary> AmazonDirectConnect exception </summary> </member> <member name="M:Amazon.DirectConnect.Model.DirectConnectServerException.#ctor(System.String)"> <summary> Constructs a new DirectConnectServerException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectConnect.Model.Interconnect"> <summary> <para>An interconnect is a connection that can host other connections.</para> <para>Like a standard Direct Connect connection, an interconnect represents the physical connection between a Direct Connect partner's network and a specific Direct Connect location. A Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.</para> <para>The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.Interconnect.WithInterconnectId(System.String)"> <summary> Sets the InterconnectId property </summary> <param name="interconnectId">The value to set for the InterconnectId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Interconnect.WithInterconnectName(System.String)"> <summary> Sets the InterconnectName property </summary> <param name="interconnectName">The value to set for the InterconnectName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Interconnect.WithInterconnectState(System.String)"> <summary> Sets the InterconnectState property </summary> <param name="interconnectState">The value to set for the InterconnectState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Interconnect.WithRegion(System.String)"> <summary> Sets the Region property </summary> <param name="region">The value to set for the Region property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Interconnect.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Interconnect.WithBandwidth(System.String)"> <summary> Sets the Bandwidth property </summary> <param name="bandwidth">The value to set for the Bandwidth property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.InterconnectId"> <summary> The ID of the interconnect. Example: dxcon-abc123 </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.InterconnectName"> <summary> The name of the interconnect. Example: "<i>1G Interconnect to AWS</i>" </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.InterconnectState"> <summary> State of the interconnect. <ul> <li><b>Requested</b>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</li> <li><b>Pending</b>: The interconnect has been approved, and is being initialized.</li> <li><b>Available</b>: The network link is up, and the interconnect is ready for use.</li> <li><b>Down</b>: The network link is down.</li> <li><b>Deleted</b>: The interconnect has been deleted.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>requested, pending, available, down, deleting, deleted</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.Region"> <summary> The AWS region where the connection is located. Example: us-east-1 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.Bandwidth"> <summary> Bandwidth of the connection. Example: 1Gbps Default: None </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocateConnectionOnInterconnectRequestMarshaller"> <summary> Allocate Connection On Interconnect Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocateConnectionOnInterconnectResponseUnmarshaller"> <summary> Response Unmarshaller for AllocateConnectionOnInterconnect operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocateConnectionOnInterconnectResultUnmarshaller"> <summary> AllocateConnectionOnInterconnectResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocatePrivateVirtualInterfaceRequestMarshaller"> <summary> Allocate Private Virtual Interface Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocatePrivateVirtualInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for AllocatePrivateVirtualInterface operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocatePrivateVirtualInterfaceResultUnmarshaller"> <summary> AllocatePrivateVirtualInterfaceResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocatePublicVirtualInterfaceRequestMarshaller"> <summary> Allocate Public Virtual Interface Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocatePublicVirtualInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for AllocatePublicVirtualInterface operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocatePublicVirtualInterfaceResultUnmarshaller"> <summary> AllocatePublicVirtualInterfaceResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmConnectionRequestMarshaller"> <summary> Confirm Connection Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for ConfirmConnection operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmConnectionResultUnmarshaller"> <summary> ConfirmConnectionResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmPrivateVirtualInterfaceRequestMarshaller"> <summary> Confirm Private Virtual Interface Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmPrivateVirtualInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for ConfirmPrivateVirtualInterface operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmPrivateVirtualInterfaceResultUnmarshaller"> <summary> ConfirmPrivateVirtualInterfaceResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmPublicVirtualInterfaceRequestMarshaller"> <summary> Confirm Public Virtual Interface Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmPublicVirtualInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for ConfirmPublicVirtualInterface operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConfirmPublicVirtualInterfaceResultUnmarshaller"> <summary> ConfirmPublicVirtualInterfaceResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.ConnectionUnmarshaller"> <summary> ConnectionUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreateConnectionRequestMarshaller"> <summary> Create Connection Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreateConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for CreateConnection operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreateConnectionResultUnmarshaller"> <summary> CreateConnectionResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreateInterconnectRequestMarshaller"> <summary> Create Interconnect Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreateInterconnectResponseUnmarshaller"> <summary> Response Unmarshaller for CreateInterconnect operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreateInterconnectResultUnmarshaller"> <summary> CreateInterconnectResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreatePrivateVirtualInterfaceRequestMarshaller"> <summary> Create Private Virtual Interface Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreatePrivateVirtualInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePrivateVirtualInterface operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreatePrivateVirtualInterfaceResultUnmarshaller"> <summary> CreatePrivateVirtualInterfaceResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreatePublicVirtualInterfaceRequestMarshaller"> <summary> Create Public Virtual Interface Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreatePublicVirtualInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePublicVirtualInterface operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreatePublicVirtualInterfaceResultUnmarshaller"> <summary> CreatePublicVirtualInterfaceResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteConnectionRequestMarshaller"> <summary> Delete Connection Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteConnection operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteConnectionResultUnmarshaller"> <summary> DeleteConnectionResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteInterconnectRequestMarshaller"> <summary> Delete Interconnect Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteInterconnectResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteInterconnect operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteInterconnectResultUnmarshaller"> <summary> DeleteInterconnectResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteVirtualInterfaceRequestMarshaller"> <summary> Delete Virtual Interface Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteVirtualInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVirtualInterface operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DeleteVirtualInterfaceResultUnmarshaller"> <summary> DeleteVirtualInterfaceResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeConnectionsOnInterconnectRequestMarshaller"> <summary> Describe Connections On Interconnect Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeConnectionsOnInterconnectResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConnectionsOnInterconnect operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeConnectionsOnInterconnectResultUnmarshaller"> <summary> DescribeConnectionsOnInterconnectResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeConnectionsRequestMarshaller"> <summary> Describe Connections Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeConnectionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConnections operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeConnectionsResultUnmarshaller"> <summary> DescribeConnectionsResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeInterconnectsRequestMarshaller"> <summary> Describe Interconnects Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeInterconnectsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeInterconnects operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeInterconnectsResultUnmarshaller"> <summary> DescribeInterconnectsResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeLocationsRequestMarshaller"> <summary> Describe Locations Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeLocationsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLocations operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeLocationsResultUnmarshaller"> <summary> DescribeLocationsResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeVirtualGatewaysRequestMarshaller"> <summary> Describe Virtual Gateways Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeVirtualGatewaysResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVirtualGateways operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeVirtualGatewaysResultUnmarshaller"> <summary> DescribeVirtualGatewaysResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeVirtualInterfacesRequestMarshaller"> <summary> Describe Virtual Interfaces Request Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeVirtualInterfacesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVirtualInterfaces operation </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.DescribeVirtualInterfacesResultUnmarshaller"> <summary> DescribeVirtualInterfacesResultUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.InterconnectUnmarshaller"> <summary> InterconnectUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.LocationUnmarshaller"> <summary> LocationUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.RouteFilterPrefixUnmarshaller"> <summary> RouteFilterPrefixUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.VirtualGatewayUnmarshaller"> <summary> VirtualGatewayUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.VirtualInterfaceUnmarshaller"> <summary> VirtualInterfaceUnmarshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Location"> <summary> <para>A Direct Connect location where connections and interconnects can be requested.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.Location.WithLocationCode(System.String)"> <summary> Sets the LocationCode property </summary> <param name="locationCode">The value to set for the LocationCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.Location.WithLocationName(System.String)"> <summary> Sets the LocationName property </summary> <param name="locationName">The value to set for the LocationName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.Location.LocationCode"> <summary> The code used to indicate the Direct Connect location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Location.LocationName"> <summary> The name of the Direct Connect location. The name includes the colocation partner name and the physical site of the lit building </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPrivateVirtualInterface"> <summary> <para>A structure containing information about a new private virtual interface.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.VirtualGatewayId"> <summary> The ID of the virtual private gateway to a VPC. Only applies to private virtual interfaces. Example: vgw-123er56 </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation"> <summary> <para>A structure containing information about a private virtual interface that will be provisioned on a connection.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPublicVirtualInterface"> <summary> <para>A structure containing information about a new public virtual interface.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithRouteFilterPrefixes(Amazon.DirectConnect.Model.RouteFilterPrefix[])"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterface.WithRouteFilterPrefixes(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.RouteFilterPrefix})"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.RouteFilterPrefixes"> <summary> A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface). </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation"> <summary> <para>A structure containing information about a public virtual interface that will be provisioned on a connection.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithRouteFilterPrefixes(Amazon.DirectConnect.Model.RouteFilterPrefix[])"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.WithRouteFilterPrefixes(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.RouteFilterPrefix})"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.RouteFilterPrefixes"> <summary> A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface). </summary> </member> <member name="T:Amazon.DirectConnect.Model.RouteFilterPrefix"> <summary> <para>A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.RouteFilterPrefix.WithCidr(System.String)"> <summary> Sets the Cidr property </summary> <param name="cidr">The value to set for the Cidr property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.RouteFilterPrefix.Cidr"> <summary> CIDR notation for the advertised route. Multiple routes are separated by commas Example: 10.10.10.0/24,10.10.11.0/24 </summary> </member> <member name="T:Amazon.DirectConnect.Model.VirtualGateway"> <summary> <para>You can create one or more Direct Connect private virtual interfaces linking to your virtual private gateway.</para> <para>Virtual private gateway can be managed via AWS Virtual Private Cloud Console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html" >EC2 CreateVpnGateway API</a> .</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.VirtualGateway.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualGateway.WithVirtualGatewayState(System.String)"> <summary> Sets the VirtualGatewayState property </summary> <param name="virtualGatewayState">The value to set for the VirtualGatewayState property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.VirtualGateway.VirtualGatewayId"> <summary> The ID of the virtual private gateway to a VPC. Only applies to private virtual interfaces. Example: vgw-123er56 </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualGateway.VirtualGatewayState"> <summary> State of the virtual private gateway. <ul> <li><b>Pending</b>: This is the initial state after calling <i>CreateVpnGateway</i>.</li> <li><b>Available</b>: Ready for use by a private virtual interface.</li> <li><b>Deleting</b>: This is the initial state after calling <i>DeleteVpnGateway</i>.</li> <li><b>Deleted</b>: In this state, a private virtual interface is unable to send traffic over this gateway.</li> </ul> </summary> </member> <member name="T:Amazon.DirectConnect.Model.VirtualInterface"> <summary> <para>A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer.</para> </summary> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithOwnerAccount(System.String)"> <summary> Sets the OwnerAccount property </summary> <param name="ownerAccount">The value to set for the OwnerAccount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithVirtualInterfaceId(System.String)"> <summary> Sets the VirtualInterfaceId property </summary> <param name="virtualInterfaceId">The value to set for the VirtualInterfaceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithConnectionId(System.String)"> <summary> Sets the ConnectionId property </summary> <param name="connectionId">The value to set for the ConnectionId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithVirtualInterfaceType(System.String)"> <summary> Sets the VirtualInterfaceType property </summary> <param name="virtualInterfaceType">The value to set for the VirtualInterfaceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithVirtualInterfaceName(System.String)"> <summary> Sets the VirtualInterfaceName property </summary> <param name="virtualInterfaceName">The value to set for the VirtualInterfaceName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithVlan(System.Int32)"> <summary> Sets the Vlan property </summary> <param name="vlan">The value to set for the Vlan property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithAsn(System.Int32)"> <summary> Sets the Asn property </summary> <param name="asn">The value to set for the Asn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithAuthKey(System.String)"> <summary> Sets the AuthKey property </summary> <param name="authKey">The value to set for the AuthKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithAmazonAddress(System.String)"> <summary> Sets the AmazonAddress property </summary> <param name="amazonAddress">The value to set for the AmazonAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithCustomerAddress(System.String)"> <summary> Sets the CustomerAddress property </summary> <param name="customerAddress">The value to set for the CustomerAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithVirtualInterfaceState(System.String)"> <summary> Sets the VirtualInterfaceState property </summary> <param name="virtualInterfaceState">The value to set for the VirtualInterfaceState property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithCustomerRouterConfig(System.String)"> <summary> Sets the CustomerRouterConfig property </summary> <param name="customerRouterConfig">The value to set for the CustomerRouterConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithVirtualGatewayId(System.String)"> <summary> Sets the VirtualGatewayId property </summary> <param name="virtualGatewayId">The value to set for the VirtualGatewayId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithRouteFilterPrefixes(Amazon.DirectConnect.Model.RouteFilterPrefix[])"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DirectConnect.Model.VirtualInterface.WithRouteFilterPrefixes(System.Collections.Generic.IEnumerable{Amazon.DirectConnect.Model.RouteFilterPrefix})"> <summary> Adds elements to the RouteFilterPrefixes collection </summary> <param name="routeFilterPrefixes">The values to add to the RouteFilterPrefixes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceId"> <summary> ID of the virtual interface. Example: dxvif-123dfg56 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.Location"> <summary> Where the connection is located. Example: EqSV5 Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.ConnectionId"> <summary> ID of the connection. Example: dxcon-fg5678gh Default: None </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceType"> <summary> The type of virtual interface Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, etc.) </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceName"> <summary> The name of the virtual interface assigned by the customer Example: "My VPC" </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.Vlan"> <summary> VLAN ID Example: 101 </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.Asn"> <summary> Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration Example: 65000 </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.AuthKey"> <summary> Authentication key for BGP configuration Example: asdf34example </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.AmazonAddress"> <summary> IP address assigned to the Amazon interface. Example: 192.168.1.1/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.CustomerAddress"> <summary> IP address assigned to the customer interface. Example: 192.168.1.2/30 </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceState"> <summary> State of the virtual interface. <ul> <li><b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</li> <li><b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</li> <li><b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</li> <li><b>Available</b>: A virtual interface that is able to forward traffic.</li> <li><b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</li> <li><b>Deleted</b>: A virtual interface that cannot forward traffic.</li> <li><b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>confirming, verifying, pending, available, deleting, deleted, rejected</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.CustomerRouterConfig"> <summary> Information for generating the customer router configuration. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualGatewayId"> <summary> The ID of the virtual private gateway to a VPC. Only applies to private virtual interfaces. Example: vgw-123er56 </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.RouteFilterPrefixes"> <summary> A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface). </summary> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDB"> <summary> Interface for accessing AmazonDynamoDBv2. Amazon DynamoDB <b>Overview</b> <para>This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the low-level DynamoDB API. For information about DynamoDB application development, go to the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/" >Amazon DynamoDB Developer Guide</a> .</para> <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, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html" >Using the AWS SDKs with DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i> .</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, go to <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> <para> <ul> <li> <para> <i>CreateTable</i> - Creates a table with user-specified provisioned throughput settings. You must designate one attribute as the hash primary key for the table; you can optionally designate a second attribute as the range primary key. DynamoDB creates indexes on these key attributes for fast data access. 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> <para>For conceptual information about managing tables, go to <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> <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 specify 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 1 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 hash key value. You can narrow the scope of the query using comparison operators against a range 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> <para>For conceptual information about reading data, go to <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> <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 1 MB. </para> </li> </ul> </para> <para>For conceptual information about modifying data, go to <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.AmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"> <summary> <para>The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in the table. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> .</para> <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 with a <i>LastEvaluatedKey</i> 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>The result set is eventually consistent. </para> <para>By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel <i>Scan</i> by specifying 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 Amazon DynamoDB Developer Guide.</para> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan service method on AmazonDynamoDBv2.</param> <returns>The response from the Scan service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginScan(Amazon.DynamoDBv2.Model.ScanRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"/> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndScan operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndScan(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScan.</param> <returns>Returns a ScanResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"> <summary> <para>Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.</para> <para>The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> section in the Amazon DynamoDB Developer Guide.</para> <para>The table must be in the <c>ACTIVE</c> state for this operation to succeed. <i>UpdateTable</i> is an asynchronous operation; while executing the operation, the table is in the <c>UPDATING</c> state. While the table is in the <c>UPDATING</c> state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the <c>ACTIVE</c> state after the <i>UpdateTable</i> operation. </para> <para>You cannot add, modify or delete indexes using <i>UpdateTable</i> . Indexes can only be defined at table creation time.</para> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable service method on AmazonDynamoDBv2.</param> <returns>The response from the UpdateTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginUpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"/> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndUpdateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTable.</param> <returns>Returns a UpdateTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"> <summary> <para>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 <c>DELETING</c> state until DynamoDB completes the deletion. If the table is in the <c>ACTIVE</c> state, you can delete it. If a table is in <c>CREATING</c> or <c>UPDATING</c> 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 <c>DELETING</c> state, no error is returned. </para> <para><b>NOTE:</b> DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. </para> <para>When you delete a table, any indexes on that table are also deleted.</para> <para>Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable service method on AmazonDynamoDBv2.</param> <returns>The response from the DeleteTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginDeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"/> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndDeleteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTable.</param> <returns>Returns a DeleteTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"> <summary> <para>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 1 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 64 KB.</para> <para><b>NOTE:</b> BatchWriteItem cannot update items. To update items, use the UpdateItem API. </para> <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>BatchGetItem</i> will throw a <i>ProvisionedThroughputExceededException</i> .</para> <para>To write one item, you can use the <i>PutItem</i> operation; to delete one item, you can use the <i>DeleteItem</i> operation.</para> <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, such as Java, 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, such as PHP, 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>The total request size exceeds 1 MB.</para> </li> <li> <para>Any individual item in a batch exceeds 64 KB.</para> </li> </ul> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem service method on AmazonDynamoDBv2.</param> <returns>The response from the BatchWriteItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginBatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"/> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchWriteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndBatchWriteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchWriteItem.</param> <returns>Returns a BatchWriteItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"> <summary> <para>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.</para> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable service method on AmazonDynamoDBv2.</param> <returns>The response from the DescribeTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginDescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"/> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndDescribeTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTable.</param> <returns>Returns a DescribeTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"> <summary> <para>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> <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <c>true</c> . 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="getItemRequest">Container for the necessary parameters to execute the GetItem service method on AmazonDynamoDBv2.</param> <returns>The response from the GetItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginGetItem(Amazon.DynamoDBv2.Model.GetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"/> </summary> <param name="getItemRequest">Container for the necessary parameters to execute the GetItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Returns a GetItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"> <summary> <para>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> <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 only deleting items if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem service method on AmazonDynamoDBv2.</param> <returns>The response from the DeleteItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginDeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"/> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndDeleteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Returns a DeleteItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"> <summary> <para>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> <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 <c>CREATING</c> . After the table is created, DynamoDB sets the <i>TableStatus</i> to <c>ACTIVE</c> . You can perform read and write operations only on an <c>ACTIVE</c> table. </para> <para>If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the <c>CREATING</c> state at any given time.</para> <para>You can use the <i>DescribeTable</i> API to check the table status.</para> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable service method on AmazonDynamoDBv2.</param> <returns>The response from the CreateTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginCreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"/> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndCreateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTable.</param> <returns>Returns a CreateTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"> <summary> <para>A <i>Query</i> operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by range key or by index key. </para> <para>Queries that do not return results consume the minimum read capacity units according to the type of read.</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 a <i>LastEvaluatedKey</i> to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns an empty result set <i>and</i> a <i>LastEvaluatedKey</i> . The <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used <i>Limit</i> . </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 <i>ConsistentRead</i> to true 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="queryRequest">Container for the necessary parameters to execute the Query service method on AmazonDynamoDBv2.</param> <returns>The response from the Query service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginQuery(Amazon.DynamoDBv2.Model.QueryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"/> </summary> <param name="queryRequest">Container for the necessary parameters to execute the Query operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndQuery operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndQuery(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQuery.</param> <returns>Returns a QueryResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"> <summary> <para>Creates a new item, or replaces an old item with a new item. If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert 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> <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> .</para> <para>You can request that <i>PutItem</i> return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the <i>ReturnValues</i> description.</para> <para><b>NOTE:</b> To prevent a new item from replacing an existing item, use a conditional put operation with Exists set to false for the primary key attribute, or attributes. </para> <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 Amazon DynamoDB Developer Guide.</para> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem service method on AmazonDynamoDBv2.</param> <returns>The response from the PutItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginPutItem(Amazon.DynamoDBv2.Model.PutItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"/> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndPutItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Returns a PutItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"> <summary> <para>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.</para> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables service method on AmazonDynamoDBv2.</param> <returns>The response from the ListTables service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginListTables(Amazon.DynamoDBv2.Model.ListTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"/> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTables operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndListTables(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTables.</param> <returns>Returns a ListTablesResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.ListTables"> <summary> <para>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.</para> </summary> <returns>The response from the ListTables service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"> <summary> <para> Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (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> <para>In addition to updating an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter.</para> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem service method on AmazonDynamoDBv2.</param> <returns>The response from the UpdateItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginUpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"/> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndUpdateItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Returns a UpdateItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"> <summary> <para>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> <para>A single operation can retrieve up to 1 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> <para>For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items (1 MB) and 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 dataset.</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 throw 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> <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 <c>true</c> 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 Amazon DynamoDB Developer Guide.</para> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem service method on AmazonDynamoDBv2.</param> <returns>The response from the BatchGetItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.BeginBatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"/> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDB.EndBatchGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetItem.</param> <returns>Returns a BatchGetItemResult from AmazonDynamoDBv2.</returns> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDBClient"> <summary> Implementation for accessing AmazonDynamoDBv2. Amazon DynamoDB <b>Overview</b> <para>This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the low-level DynamoDB API. For information about DynamoDB application development, go to the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/" >Amazon DynamoDB Developer Guide</a> .</para> <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, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html" >Using the AWS SDKs with DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i> .</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, go to <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> <para> <ul> <li> <para> <i>CreateTable</i> - Creates a table with user-specified provisioned throughput settings. You must designate one attribute as the hash primary key for the table; you can optionally designate a second attribute as the range primary key. DynamoDB creates indexes on these key attributes for fast data access. 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> <para>For conceptual information about managing tables, go to <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> <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 specify 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 1 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 hash key value. You can narrow the scope of the query using comparison operators against a range 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> <para>For conceptual information about reading data, go to <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> <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 1 MB. </para> </li> </ul> </para> <para>For conceptual information about modifying data, go to <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> <summary> Implementation for accessing AmazonDynamoDBv2. Amazon DynamoDB <b>Overview</b> <para>This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the Amazon DynamoDB API. </para> </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDynamoDBv2 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"> <summary> <para>The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in the table. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> .</para> <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 with a <i>LastEvaluatedKey</i> 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>The result set is eventually consistent. </para> <para>By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel <i>Scan</i> by specifying 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 Amazon DynamoDB Developer Guide.</para> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan service method on AmazonDynamoDBv2.</param> <returns>The response from the Scan service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginScan(Amazon.DynamoDBv2.Model.ScanRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"/> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndScan operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndScan(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScan.</param> <returns>Returns a ScanResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"> <summary> <para>Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.</para> <para>The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> section in the Amazon DynamoDB Developer Guide.</para> <para>The table must be in the <c>ACTIVE</c> state for this operation to succeed. <i>UpdateTable</i> is an asynchronous operation; while executing the operation, the table is in the <c>UPDATING</c> state. While the table is in the <c>UPDATING</c> state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the <c>ACTIVE</c> state after the <i>UpdateTable</i> operation. </para> <para>You cannot add, modify or delete indexes using <i>UpdateTable</i> . Indexes can only be defined at table creation time.</para> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable service method on AmazonDynamoDBv2.</param> <returns>The response from the UpdateTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginUpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"/> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndUpdateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTable.</param> <returns>Returns a UpdateTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"> <summary> <para>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 <c>DELETING</c> state until DynamoDB completes the deletion. If the table is in the <c>ACTIVE</c> state, you can delete it. If a table is in <c>CREATING</c> or <c>UPDATING</c> 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 <c>DELETING</c> state, no error is returned. </para> <para><b>NOTE:</b> DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. </para> <para>When you delete a table, any indexes on that table are also deleted.</para> <para>Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable service method on AmazonDynamoDBv2.</param> <returns>The response from the DeleteTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginDeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"/> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndDeleteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTable.</param> <returns>Returns a DeleteTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"> <summary> <para>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 1 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 64 KB.</para> <para><b>NOTE:</b> BatchWriteItem cannot update items. To update items, use the UpdateItem API. </para> <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>BatchGetItem</i> will throw a <i>ProvisionedThroughputExceededException</i> .</para> <para>To write one item, you can use the <i>PutItem</i> operation; to delete one item, you can use the <i>DeleteItem</i> operation.</para> <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, such as Java, 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, such as PHP, 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>The total request size exceeds 1 MB.</para> </li> <li> <para>Any individual item in a batch exceeds 64 KB.</para> </li> </ul> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem service method on AmazonDynamoDBv2.</param> <returns>The response from the BatchWriteItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginBatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"/> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchWriteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndBatchWriteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchWriteItem.</param> <returns>Returns a BatchWriteItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"> <summary> <para>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.</para> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable service method on AmazonDynamoDBv2.</param> <returns>The response from the DescribeTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginDescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"/> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndDescribeTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTable.</param> <returns>Returns a DescribeTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"> <summary> <para>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> <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <c>true</c> . 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="getItemRequest">Container for the necessary parameters to execute the GetItem service method on AmazonDynamoDBv2.</param> <returns>The response from the GetItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginGetItem(Amazon.DynamoDBv2.Model.GetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"/> </summary> <param name="getItemRequest">Container for the necessary parameters to execute the GetItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Returns a GetItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"> <summary> <para>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> <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 only deleting items if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem service method on AmazonDynamoDBv2.</param> <returns>The response from the DeleteItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginDeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"/> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndDeleteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Returns a DeleteItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"> <summary> <para>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> <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 <c>CREATING</c> . After the table is created, DynamoDB sets the <i>TableStatus</i> to <c>ACTIVE</c> . You can perform read and write operations only on an <c>ACTIVE</c> table. </para> <para>If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the <c>CREATING</c> state at any given time.</para> <para>You can use the <i>DescribeTable</i> API to check the table status.</para> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable service method on AmazonDynamoDBv2.</param> <returns>The response from the CreateTable service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginCreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"/> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTable operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndCreateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTable.</param> <returns>Returns a CreateTableResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Query(Amazon.DynamoDBv2.Model.QueryRequest)"> <summary> <para>A <i>Query</i> operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by range key or by index key. </para> <para>Queries that do not return results consume the minimum read capacity units according to the type of read.</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 a <i>LastEvaluatedKey</i> to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns an empty result set <i>and</i> a <i>LastEvaluatedKey</i> . The <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used <i>Limit</i> . </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 <i>ConsistentRead</i> to true 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="queryRequest">Container for the necessary parameters to execute the Query service method on AmazonDynamoDBv2.</param> <returns>The response from the Query service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginQuery(Amazon.DynamoDBv2.Model.QueryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"/> </summary> <param name="queryRequest">Container for the necessary parameters to execute the Query operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndQuery operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndQuery(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQuery.</param> <returns>Returns a QueryResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"> <summary> <para>Creates a new item, or replaces an old item with a new item. If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert 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> <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> .</para> <para>You can request that <i>PutItem</i> return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the <i>ReturnValues</i> description.</para> <para><b>NOTE:</b> To prevent a new item from replacing an existing item, use a conditional put operation with Exists set to false for the primary key attribute, or attributes. </para> <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 Amazon DynamoDB Developer Guide.</para> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem service method on AmazonDynamoDBv2.</param> <returns>The response from the PutItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginPutItem(Amazon.DynamoDBv2.Model.PutItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"/> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndPutItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Returns a PutItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"> <summary> <para>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.</para> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables service method on AmazonDynamoDBv2.</param> <returns>The response from the ListTables service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginListTables(Amazon.DynamoDBv2.Model.ListTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"/> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTables operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndListTables(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTables.</param> <returns>Returns a ListTablesResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables"> <summary> <para>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.</para> </summary> <returns>The response from the ListTables service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"> <summary> <para> Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (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> <para>In addition to updating an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter.</para> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem service method on AmazonDynamoDBv2.</param> <returns>The response from the UpdateItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginUpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"/> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndUpdateItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Returns a UpdateItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"> <summary> <para>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> <para>A single operation can retrieve up to 1 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> <para>For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items (1 MB) and 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 dataset.</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 throw 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> <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 <c>true</c> 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 Amazon DynamoDB Developer Guide.</para> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem service method on AmazonDynamoDBv2.</param> <returns>The response from the BatchGetItem service method, as returned by AmazonDynamoDBv2.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginBatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"/> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem operation on AmazonDynamoDBv2.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndBatchGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetItem.</param> <returns>Returns a BatchGetItemResult from AmazonDynamoDBv2.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.pauseExponentially(System.Int32)"> <summary> Override the pausing function so retries would happen more frequent then the default operation. </summary> <param name="retries">Current number of retries.</param> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDBConfig"> <summary> Configuration for accessing Amazon DynamoDB service </summary> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.DynamoDBv2.AmazonDynamoDBConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.DynamoDBv2.AmazonDynamoDBConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBAttribute"> <summary> Base DynamoDB attribute. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBTableAttribute"> <summary> DynamoDB attribute that marks a class. Specifies that this object can be stored in DynamoDB, the name of the target table, and if attribute names must be automatically converted to lowerCamelCase. Need not be declared on subclasses if present on base class. Can be defined on subclasses to specify different target table or specify different attribute casing. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBIgnoreAttribute"> <summary> DynamoDB attribute that directs the specified attribute not to be included when saving or loading objects. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBRenamableAttribute"> <summary> DynamoDB property attribute. Can be used to specify an alternative attribute name or configure a custom converter. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBRenamableAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBRenamableAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBRenamableAttribute.AttributeName"> <summary> Name of attribute that is associated with this member. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBVersionAttribute"> <summary> DynamoDB property attribute that marks up current member as item version. At most one member in a class may be marked with this attribute. Members that are marked as version must be of primitive, numeric, integer, nullable type (e.g. int?, long?, byte?) </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBPropertyAttribute"> <summary> DynamoDB property attribute. Can be used to specify an alternative attribute name or configure a custom converter. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBPropertyAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBPropertyAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBPropertyAttribute.#ctor(System.Type)"> <summary> Constructor that specifies a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="converter">Custom converter type.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBPropertyAttribute.#ctor(System.String,System.Type)"> <summary> Constructor that specifies an alternate attribute name and a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> <param name="converter">Custom converter type.</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBPropertyAttribute.Converter"> <summary> Type of the custom converter. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBHashKeyAttribute"> <summary> DynamoDB property attribute that marks up current member as a hash key element. Exactly one member in a class must be marked with this attribute. Members that are marked as hash key must be convertible to a Primitive object. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBHashKeyAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBHashKeyAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBHashKeyAttribute.#ctor(System.Type)"> <summary> Constructor that specifies a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="converter">Custom converter type.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBHashKeyAttribute.#ctor(System.String,System.Type)"> <summary> Constructor that specifies an alternate attribute name and a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> <param name="converter">Custom converter type.</param> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBRangeKeyAttribute"> <summary> DynamoDB property attribute that marks up current member as range key element (for a hash-and-range primary key). At most one member in a class may be marked with this attribute. Members that are marked as a range key element must be convertible to a Primitive object. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBRangeKeyAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBRangeKeyAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBRangeKeyAttribute.#ctor(System.Type)"> <summary> Constructor that specifies a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="converter">Custom converter type.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBRangeKeyAttribute.#ctor(System.String,System.Type)"> <summary> Constructor that specifies an alternate attribute name and a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> <param name="converter">Custom converter type.</param> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexHashKeyAttribute"> DynamoDB property attribute that marks up current member as a hash key element for a Global Secondary Index on a table. Members that are marked as a Global Secondary Index hash key element must be convertible to a Primitive object. </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexHashKeyAttribute.#ctor(System.String)"> <summary> Constructor that accepts a single inde name. </summary> <param name="indexName">Name of the Local Secondary Index this range key belongs to.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexHashKeyAttribute.#ctor(System.String[])"> <summary> Constructor that accepts multiple index names. </summary> <param name="indexNames">Names of the Local Secondary Indexes this range key belongs to.</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexHashKeyAttribute.IndexNames"> <summary> Index associated with this range key </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexRangeKeyAttribute"> DynamoDB property attribute that marks up current member as range key element for a Global Secondary Index on a table. Members that are marked as a Global Secondary Index range key element must be convertible to a Primitive object. </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexRangeKeyAttribute.#ctor(System.String)"> <summary> Constructor that accepts a single inde name. </summary> <param name="indexName">Name of the Local Secondary Index this range key belongs to.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexRangeKeyAttribute.#ctor(System.String[])"> <summary> Constructor that accepts multiple index names. </summary> <param name="indexNames">Names of the Local Secondary Indexes this range key belongs to.</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBGlobalSecondaryIndexRangeKeyAttribute.IndexNames"> <summary> Index associated with this range key </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBLocalSecondaryIndexRangeKeyAttribute"> <summary> DynamoDB property that marks up current member as range key element for a Local Secondary Index on a table. Members that are marked as a Local Secondary Index range key element must be convertible to a Primitive object. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBLocalSecondaryIndexRangeKeyAttribute.#ctor(System.String)"> <summary> Constructor that accepts a single inde name. </summary> <param name="indexName">Name of the Local Secondary Index this range key belongs to.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBLocalSecondaryIndexRangeKeyAttribute.#ctor(System.String[])"> <summary> Constructor that accepts multiple index names. </summary> <param name="indexNames">Names of the Local Secondary Indexes this range key belongs to.</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBLocalSecondaryIndexRangeKeyAttribute.IndexNames"> <summary> Index associated with this range key </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> </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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.BatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.BatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </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.BatchGet`1"> <summary> Represents a strongly-typed object for retrieving a batch of items from a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet`1.AddKey(System.Object)"> <summary> Add a single item to get, identified by its hash primary key. </summary> <param name="hashKey">Hash key of the item to get</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet`1.AddKey(System.Object,System.Object)"> <summary> Add a single item to get, identified by its hash-and-range primary key. </summary> <param name="hashKey">Hash key of the item to get</param> <param name="rangeKey">Range key of the item to get</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet`1.AddKey(`0)"> <summary> Add a single item to get. </summary> <param name="keyObject">Object key of the item to get</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet`1.Combine(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Creates a MultiTableBatchGet object that is a combination of the current BatchGet and the specified BatchGets </summary> <param name="otherBatches">Other BatchGet objects</param> <returns> MultiTableBatchGet consisting of the multiple BatchGet objects: the current batch and the passed-in batches. </returns> </member> <member name="P:Amazon.DynamoDBv2.DataModel.BatchGet`1.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </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> </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="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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</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> </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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.BatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.BatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </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.BatchWrite`1"> <summary> Represents a strongly-typed object for writing/deleting a batch of items in a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite`1.Combine(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Creates a MultiTableBatchWrite object that is a combination of the current BatchWrite and the specified BatchWrites </summary> <param name="otherBatches">Other BatchWrite objects</param> <returns> MultiTableBatchWrite consisting of the multiple BatchWrite objects: the current batch and the passed-in batches. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite`1.AddPutItems(System.Collections.Generic.IEnumerable{`0})"> <summary> Add a number of items to be put in the current batch operation </summary> <param name="values">Items to put</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite`1.AddPutItem(`0)"> <summary> Add a single item to be put in the current batch operation </summary> <param name="item"></param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite`1.AddDeleteItems(System.Collections.Generic.IEnumerable{`0})"> <summary> Add a number of items to be deleted in the current batch operation </summary> <param name="values">Items to be deleted</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite`1.AddDeleteItem(`0)"> <summary> Add a single item to be deleted in the current batch operation. </summary> <param name="item">Item to be deleted</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite`1.AddDeleteKey(System.Object)"> <summary> Add a single item to be deleted in the current batch operation. Item is identified by its hash primary key. </summary> <param name="hashKey">Hash key of the item to delete</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite`1.AddDeleteKey(System.Object,System.Object)"> <summary> Add a single item to be deleted in the current batch operation. Item is identified by its hash-and-range primary key. </summary> <param name="hashKey">Hash key of the item to delete</param> <param name="rangeKey">Range key of the item to delete</param> </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> </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="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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </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="T:Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig"> <summary> Configuration object for setting options on the DynamoDBContext. and individual operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig.ConsistentRead"> <summary> Property that directs DynamoDBContext to use consistent reads. If property is not set, behavior defaults to non-consistent reads. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig.SkipVersionCheck"> <summary> Property that directs DynamoDBContext to skip version checks when saving or deleting an object with a version attribute. If property is not set, version checks are performed. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig.TableNamePrefix"> <summary> Property that directs DynamoDBContext to prefix all table names with a specific string. If property is null or empty, no prefix is used and default table names are used. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig.IgnoreNullValues"> <summary> Property that directs DynamoDBContext to ignore null values on attributes during a Save operation. If the property is false (or not set), null values will be interpreted as directives to delete the specific attribute. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig"> <summary> Configuration object for setting options for individual operations. This will override any settings specified by the DynamoDBContext's DynamoDBContextConfig object. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig.OverrideTableName"> <summary> Property that indicates the table to save an object to overriding the DynamoDBTable attribute declared for the type. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig.BackwardQuery"> <summary> Property that indicates a query should traverse the index backward. If the property is false (or not set), traversal shall be forward. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig.IndexName"> <summary> Property indicating the name of the index to query against. This value is optional if the index name can be inferred from the query call. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig.ConditionalOperator"> <summary> A logical operator to apply to the filter conditions: AND - If all of the conditions evaluate to true, then the entire filter evaluates to true. OR - If at least one of the conditions evaluate to true, then the entire filter evaluates to true. Default value is AND. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig.QueryFilter"> <summary> Query filter for the Query operation operation. Evaluates the query results and returns only the matching values. If you specify more than one condition, then by default all of the conditions must evaluate to true. To match only some conditions, set ConditionalOperator to Or. Note: Conditions must be against non-key properties. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.ScanCondition"> <summary> Class describing a single scan condition </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.ScanCondition.#ctor(System.String,Amazon.DynamoDBv2.DocumentModel.ScanOperator,System.Object[])"> <summary> Initializes a ScanCondition with the target property, the comparison operator and values being tested against. </summary> <param name="propertyName">Name of the property</param> <param name="op">Comparison operator</param> <param name="values"> Value(s) being tested against. The values should be of the same type as the property. In the cases where the property is a collection, the values should be of the same type as the items in the collection. </param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.ScanCondition.PropertyName"> <summary> Name of the property being tested </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.ScanCondition.Operator"> <summary> Comparison operator </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.ScanCondition.Values"> <summary> Values being tested against. The values should be of the same type as the property. In the cases where the property is a collection, the values should be of the same type as the items in the collection. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.QueryCondition"> <summary> Class describing a single query condition </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.QueryCondition.#ctor(System.String,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Object[])"> <summary> Initializes a ScanCondition with the target property, the comparison operator and values being tested against. </summary> <param name="propertyName">Name of the property</param> <param name="op">Comparison operator</param> <param name="values"> Value(s) being tested against. The values should be of the same type as the property. In the cases where the property is a collection, the values should be of the same type as the items in the collection. </param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.QueryCondition.PropertyName"> <summary> Name of the property being tested </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.QueryCondition.Operator"> <summary> Comparison operator </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.QueryCondition.Values"> <summary> Values being tested against. The values should be of the same type as the property. In the cases where the property is a collection, the values should be of the same type as the items in the collection. </summary> </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> </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> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Save``1(``0)"> <summary> Saves an object to DynamoDB. Uses DynamoDBContextConfig configured 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> </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.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.BeginSave``1(``0,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginSave``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.EndSave(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSave.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.Load``1(System.Object)"> <summary> Loads an object from DynamoDB for the given hash primary key. Uses DynamoDBContextConfig configured 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 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. Uses DynamoDBContextConfig configured 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)"> <summary> Loads an object from DynamoDB for the given key. The keyObject is a partially-specified instance, where the hash/range properties are equal to the key of the item you want to load. Uses DynamoDBContextConfig configured 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> <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.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.BeginLoad``1(System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginLoad``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginLoad``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginLoad``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginLoad``1(``0,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginLoad``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.EndLoad``1(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLoad.</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. Uses DynamoDBContextConfig configured 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 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 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.BeginDelete``1(``0,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginDelete``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.EndDelete(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDelete.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.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.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.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.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.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.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.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)"> <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> <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)"> <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.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)"> <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.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"> <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.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.AmazonDynamoDB)"> <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.AmazonDynamoDB,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.Save``1(``0)"> <summary> Saves an object to DynamoDB. Uses DynamoDBContextConfig configured 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> </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.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.BeginSave``1(``0,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginSave``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.EndSave(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSave.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"> <summary> Loads an object from DynamoDB for the given hash primary key. Uses DynamoDBContextConfig configured 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 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. Uses DynamoDBContextConfig configured 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)"> <summary> Loads an object from DynamoDB for the given key. The keyObject is a partially-specified instance, where the hash/range properties are equal to the key of the item you want to load. Uses DynamoDBContextConfig configured 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> <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.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.BeginLoad``1(System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginLoad``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginLoad``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginLoad``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginLoad``1(``0,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginLoad``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.EndLoad``1(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLoad.</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. Uses DynamoDBContextConfig configured 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 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 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.BeginDelete``1(``0,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginDelete``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginDelete``1(System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginDelete``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginDelete``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginDelete``1(System.Object,System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.EndDelete(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDelete.</param> </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.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.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.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)"> <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> <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"> <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.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="T:Amazon.DynamoDBv2.DocumentModel.Document"> <summary> A collection of attribute key-value pairs that defines an item in DynamoDB. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.#ctor"> <summary> Constructs an empty Document. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.#ctor(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry})"> <summary> Constructs a Document with the passed-in values as its attribute values. </summary> <param name="values"></param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.IsAttributeChanged(System.String)"> <summary> Returns true if the attribute has been changed. </summary> <param name="attributeName">Name of the attribute.</param> <returns>True if the attribute has been changed.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.IsDirty"> <summary> Returns true if the document contains attributes that have not been saved. </summary> <returns>True if the document contains attributes that have not been saved.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.TryGetValue(System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry@)"> <summary> Gets the value associated with the specified attribute value. </summary> <param name="attributeName">Attribute name</param> <param name="entry"> If the specified attribute value is found, returns the value associated with the attribute; otherwise, null. </param> <returns>True if attribute is found; false otherwise</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.Contains(System.String)"> <summary> Determines if a specific attribute is set on the Document. </summary> <param name="attributeName">Attribute name</param> <returns>Returns true if the specified attribute is found; false otherwise.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.ToAttributeMap"> <summary> Creates a map of attribute names mapped to AttributeValue objects. </summary> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.ToExpectedAttributeMap"> <summary> Creates a map of attribute names mapped to ExpectedAttributeValue objects. </summary> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.ToAttributeUpdateMap(System.Boolean)"> <summary> Creates a map of attribute names mapped to AttributeValueUpdate objects. </summary> <param name="changedAttributesOnly">If true, only attributes that have been changed will be in the map.</param> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.GetAttributeNames"> <summary> Returns the names of all the attributes. </summary> <returns>List of attribute names.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.FromAttributeMap(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Creates a Document from an attribute map. </summary> <param name="data">Map of attribute names to attribute values.</param> <returns>Document representing the data.</returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Document.Item(System.String)"> <summary> Attribute accessor, allows getting or setting of an individual attribute. </summary> <param name="key">Name of the attribute.</param> <returns>Current value of the attribute.</returns> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet"> <summary> Class for retrieving a batch of Documents from a single DynamoDB table. </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="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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </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> </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="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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</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.MultiBatchGet"> <summary> Internal class for handling multi-table batch gets. </summary> </member> <member name="F:Amazon.DynamoDBv2.DocumentModel.MultiBatchGet.MaxItemsPerCall"> <summary> Maximum number of items that can be sent in a single BatchGet request </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiBatchGet.GetItems"> <summary> Gets items ocnfigured in Batches from the server </summary> <returns></returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.MultiBatchGet.Batches"> <summary> Batches that comprise the current BatchGet operation </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> </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="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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite"> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </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="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.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</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.MultiBatchWrite"> <summary> Internal class for handling multi-table batch writes. </summary> </member> <member name="F:Amazon.DynamoDBv2.DocumentModel.MultiBatchWrite.MaxItemsPerCall"> <summary> Maximum number of items that can be sent in a single BatchWrite request </summary> </member> <member name="F:Amazon.DynamoDBv2.DocumentModel.MultiBatchWrite.tableMap"> <summary> Map which stores tables by its name. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiBatchWrite.WriteItems(System.Boolean)"> <summary> Pushes items configured in Batches to the server </summary> <param name="isAsync"></param> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.MultiBatchWrite.Batches"> <summary> Batches that comprise the current BatchWrite operation </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntryType"> <summary> Enumerator describing type of DynamoDB data </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Abstract class representing an arbitrary DynamoDB attribute value </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsPrimitive"> <summary> Convert DynamoDBEntry to Primitive </summary> <returns> Primitive if DynamoDBEntry is of Primitive type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsPrimitiveList"> <summary> Convert DynamoDBEntry to PrimitiveList </summary> <returns> AsPrimitiveList if DynamoDBEntry is of AsPrimitiveList type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsBoolean"> <summary> Explicitly convert DynamoDBEntry to Boolean </summary> <returns>Boolean value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Boolean)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Boolean to DynamoDBEntry </summary> <param name="data">Boolean data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Boolean"> <summary> Explicitly convert DynamoDBEntry to Boolean </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Boolean value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsByte"> <summary> Explicitly convert DynamoDBEntry to Byte </summary> <returns>Byte value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Byte)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Byte to DynamoDBEntry </summary> <param name="data">Byte data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Byte"> <summary> Explicitly convert DynamoDBEntry to Byte </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Byte value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsSByte"> <summary> Explicitly convert DynamoDBEntry to SByte </summary> <returns>SByte value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.SByte)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert SByte to DynamoDBEntry </summary> <param name="data">SByte data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.SByte"> <summary> Explicitly convert DynamoDBEntry to SByte </summary> <param name="p">DynamoDBEntry to convert</param> <returns>SByte value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsUShort"> <summary> Explicitly convert DynamoDBEntry to UInt16 </summary> <returns>UInt16 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.UInt16)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert UInt16 to DynamoDBEntry </summary> <param name="data">UInt16 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.UInt16"> <summary> Explicitly convert DynamoDBEntry to UInt16 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>UInt16 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsShort"> <summary> Explicitly convert DynamoDBEntry to Int16 </summary> <returns>Int16 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Int16)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Int16 to DynamoDBEntry </summary> <param name="data">Int16 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Int16"> <summary> Explicitly convert DynamoDBEntry to Int16 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Int16 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsUInt"> <summary> Explicitly convert DynamoDBEntry to UInt32 </summary> <returns>UInt32 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.UInt32)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert UInt32 to DynamoDBEntry </summary> <param name="data">UInt32 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.UInt32"> <summary> Explicitly convert DynamoDBEntry to UInt32 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>UInt32 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsInt"> <summary> Explicitly convert DynamoDBEntry to Int32 </summary> <returns>Int32 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Int32)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Int32 to DynamoDBEntry </summary> <param name="data">Int32 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Int32"> <summary> Explicitly convert DynamoDBEntry to Int32 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Int32 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsULong"> <summary> Explicitly convert DynamoDBEntry to UInt64 </summary> <returns>UInt64 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.UInt64)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert UInt64 to DynamoDBEntry </summary> <param name="data">UInt64 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.UInt64"> <summary> Explicitly convert DynamoDBEntry to UInt64 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>UInt64 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsLong"> <summary> Explicitly convert DynamoDBEntry to Int64 </summary> <returns>Int64 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Int64)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Int64 to DynamoDBEntry </summary> <param name="data">Int64 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Int64"> <summary> Explicitly convert DynamoDBEntry to Int64 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Int64 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsSingle"> <summary> Explicitly convert DynamoDBEntry to Single </summary> <returns>Single value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Single)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Single to DynamoDBEntry </summary> <param name="data">Single data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Single"> <summary> Explicitly convert DynamoDBEntry to Single </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Single value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsDouble"> <summary> Explicitly convert DynamoDBEntry to Double </summary> <returns>Double value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Double)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Double to DynamoDBEntry </summary> <param name="data">Double data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Double"> <summary> Explicitly convert DynamoDBEntry to Double </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Double value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsDecimal"> <summary> Explicitly convert DynamoDBEntry to Decimal </summary> <returns>Decimal value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Decimal)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Decimal to DynamoDBEntry </summary> <param name="data">Decimal data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Decimal"> <summary> Explicitly convert DynamoDBEntry to Decimal </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Decimal value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsChar"> <summary> Explicitly convert DynamoDBEntry to Char </summary> <returns>Char value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Char)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Char to DynamoDBEntry </summary> <param name="data">Char data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Char"> <summary> Explicitly convert DynamoDBEntry to Char </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Char value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsString"> <summary> Explicitly convert DynamoDBEntry to String </summary> <returns>String value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.String)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert String to DynamoDBEntry </summary> <param name="data">String data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.String"> <summary> Explicitly convert DynamoDBEntry to String </summary> <param name="p">DynamoDBEntry to convert</param> <returns>String value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsDateTime"> <summary> Explicitly convert DynamoDBEntry to DateTime </summary> <returns>DateTime value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.DateTime)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert DateTime to DynamoDBEntry </summary> <param name="data">DateTime data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.DateTime"> <summary> Explicitly convert DynamoDBEntry to DateTime </summary> <param name="p">DynamoDBEntry to convert</param> <returns>DateTime value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsGuid"> <summary> Explicitly convert DynamoDBEntry to Guid </summary> <returns>Guid value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Guid)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Guid to DynamoDBEntry </summary> <param name="data">Guid data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Guid"> <summary> Explicitly convert DynamoDBEntry to Guid </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Guid value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsByteArray"> <summary> Explicitly convert DynamoDBEntry to byte[] </summary> <returns>byte[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Byte[])~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert byte[] to DynamoDBEntry </summary> <param name="data">byte[] data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Byte[]"> <summary> Explicitly convert DynamoDBEntry to byte[] </summary> <param name="p">DynamoDBEntry to convert</param> <returns>byte[] value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsMemoryStream"> <summary> Explicitly convert DynamoDBEntry to MemoryStream </summary> <returns>MemoryStream value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.IO.MemoryStream)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert MemoryStream to DynamoDBEntry </summary> <param name="data">MemoryStream data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.IO.MemoryStream"> <summary> Explicitly convert DynamoDBEntry to MemoryStream </summary> <param name="p">DynamoDBEntry to convert</param> <returns>MemoryStream value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsListOfPrimitives"> <summary> Explicitly convert DynamoDBEntry to List<Primitive> </summary> <returns>List<Primitive> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.Primitive})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<Primitive> to DynamoDBEntry </summary> <param name="data">List<Primitive> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.Primitive}"> <summary> Explicitly convert DynamoDBEntry to List<Primitive> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<Primitive> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsListOfString"> <summary> Explicitly convert DynamoDBEntry to List<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{System.String})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<String> to DynamoDBEntry </summary> <param name="data">List<String> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{System.String}"> <summary> Explicitly convert DynamoDBEntry to List<String> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<String> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsListOfByteArray"> <summary> Explicitly convert DynamoDBEntry to List<byte[]> </summary> <returns>List<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{System.Byte[]})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<byte[]> to DynamoDBEntry </summary> <param name="data">List<byte[]> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{System.Byte[]}"> <summary> Explicitly convert DynamoDBEntry to List<byte[]> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<byte[]> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsListOfMemoryStream"> <summary> Explicitly convert DynamoDBEntry to List<MemoryStream> </summary> <returns>List<MemoryStream> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{System.IO.MemoryStream})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<MemoryStream> to DynamoDBEntry </summary> <param name="data">List<MemoryStream> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{System.IO.MemoryStream}"> <summary> Explicitly convert DynamoDBEntry to List<MemoryStream> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<MemoryStream> value of DynamoDBEntry</returns> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.ExpectedValue"> <summary> Expected state of an attribute in DynamoDB. Exists cannot be set at the same time as Comparison and Values. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedValue.#ctor(System.Boolean)"> <summary> Constructs an ExpectedValue with a given Exists value. </summary> <param name="exists"> Flag whether the attribute should exist or not. </param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedValue.#ctor(Amazon.DynamoDBv2.DocumentModel.ScanOperator,Amazon.DynamoDBv2.DocumentModel.Primitive[])"> <summary> Constructs an ExpectedValue with a given comparison and value(s). </summary> <param name="comparison"></param> <param name="values"></param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedValue.ToExpectedAttributeValue"> <summary> Converts this ExpectedValue instance to Amazon.DynamoDBv2.Model.ExpectedAttributeValue </summary> <returns>Amazon.DynamoDBv2.Model.ExpectedAttributeValue</returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ExpectedValue.Exists"> <summary> Flag whether the attribute should exist or not. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ExpectedValue.Comparison"> <summary> Comparison operator for the expected value. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ExpectedValue.Values"> <summary> Values to compare the attribute against. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.ExpectedState"> <summary> Expected state of an item in DynamoDB. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedState.#ctor"> <summary> Constructs an empty ExpectedState with ConditionalOeprator set to AND. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedState.AddExpected(System.String,System.Boolean)"> <summary> Adds an ExpectedValue with the specific Exists value for the attribute. </summary> <param name="attributeName">Attribute that is being tested</param> <param name="exists">Flag whether the attribute should exist or not.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedState.AddExpected(System.String,Amazon.DynamoDBv2.DocumentModel.ScanOperator,Amazon.DynamoDBv2.DocumentModel.Primitive[])"> <summary> Adds an ExpectedValue with the specific Comparison and Values for the attribute. </summary> <param name="attributeName">Attribute that is being tested</param> <param name="comparison">Comparison operator for the expected value.</param> <param name="values">Values to compare the attribute against.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedState.ToExpectedAttributeMap"> <summary> Creates a map of attribute names mapped to ExpectedAttributeValue objects. </summary> <returns></returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ExpectedState.ExpectedValues"> <summary> Attribute name to ExpectedValue mapping. Represents the expected state of a number of attributes of a DynamoDB item. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ExpectedState.ConditionalOperator"> <summary> Operator dictating whether ALL or SOME of the expected values must be true to satisfy the overall expected state. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.Filter"> <summary> Filter for use with scan and query operations </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Filter.ToConditions"> <summary> Converts filter to a map of conditions </summary> <returns>Map from attribute name to condition</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Filter.FromConditions(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> Creates a Filter from a conditions map </summary> <param name="conditions">Map from attribute name to condition</param> <returns>Equivalent Filter</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Filter.op_Implicit(Amazon.DynamoDBv2.DocumentModel.Filter)~System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition}"> <summary> Implicitly converts Filter to map of conditions </summary> <param name="f">Filter to convert</param> <returns>Map from attribute name to condition</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Filter.op_Implicit(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})~Amazon.DynamoDBv2.DocumentModel.Filter"> <summary> Implicitly converts map of conditions to Filter </summary> <param name="conditions">Map from attribute name to condition</param> <returns>Equivalent Filter</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Filter.AddCondition(System.String,Amazon.DynamoDBv2.Model.Condition)"> <summary> Adds a condition for a specified attribute. If a condition for the attribute already exists, it will be replaced with the new condition. </summary> <param name="attributeName">Target attribute name</param> <param name="condition">Condition to be added</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Filter.RemoveCondition(System.String)"> <summary> Removes a condition for a specific attribute name. </summary> <param name="attributeName">Target attribute</param> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.ScanFilter"> <summary> Scan filter. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ScanFilter.AddCondition(System.String,Amazon.DynamoDBv2.DocumentModel.ScanOperator,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Adds a condition for a specified attribute that consists of an operator and any number of AttributeValues. </summary> <param name="attributeName">Target attribute name</param> <param name="op">Comparison operator</param> <param name="values">AttributeValues to compare to</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ScanFilter.AddCondition(System.String,Amazon.DynamoDBv2.DocumentModel.ScanOperator,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry[])"> <summary> Adds a condition for a specified attribute that consists of an operator and any number of values </summary> <param name="attributeName">Target attribute name</param> <param name="op">Comparison operator</param> <param name="values">Values to compare to</param> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.QueryFilter"> <summary> Query filter. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryFilter.#ctor"> <summary> Constructs an empty QueryFilter instance </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryFilter.#ctor(System.String,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Constructs an instance of QueryFilter with a single condition. More conditions can be added after initialization. </summary> <param name="attributeName">Target attribute name</param> <param name="op">Comparison operator</param> <param name="values">Attributes to compare</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryFilter.#ctor(System.String,Amazon.DynamoDBv2.DocumentModel.QueryOperator,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry[])"> <summary> Constructs an instance of QueryFilter with a single condition. More conditions can be added after initialization. </summary> <param name="attributeName">Target attribute name</param> <param name="op">Comparison operator</param> <param name="values">Attributes to compare</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryFilter.AddCondition(System.String,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Adds a condition for a specified key attribute that consists of an operator and any number of AttributeValues. </summary> <param name="keyAttributeName">Target key attribute name</param> <param name="op">Comparison operator</param> <param name="values">AttributeValues to compare to</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryFilter.AddCondition(System.String,Amazon.DynamoDBv2.DocumentModel.QueryOperator,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry[])"> <summary> Adds a condition for a specified key attribute that consists of an operator and any number of values </summary> <param name="keyAttributeName">Target key attribute name</param> <param name="op">Comparison operator</param> <param name="values">Values to compare to</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryFilter.AddCondition(System.String,Amazon.DynamoDBv2.DocumentModel.ScanOperator,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Adds a condition for a specified non-key attribute that consists of an operator and any number of AttributeValues. </summary> <param name="nonKeyAttributeName">Target non-key attribute name</param> <param name="op">Comparison operator</param> <param name="values">AttributeValues to compare to</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryFilter.AddCondition(System.String,Amazon.DynamoDBv2.DocumentModel.ScanOperator,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry[])"> <summary> Adds a condition for a specified non-key attribute that consists of an operator and any number of values </summary> <param name="nonKeyAttributeName">Target non-key attribute name</param> <param name="op">Comparison operator</param> <param name="values">Values to compare to</param> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> A DynamoDBEntry that represents a primitive DynamoDB type </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.#ctor"> <summary> Constructs an empty Primitive </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.#ctor(System.String)"> <summary> Constructs a Primitive with the specified value. Value is stored as a string, not numeric. </summary> <param name="value">Value of the Primitive</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.#ctor(System.String,System.Boolean)"> <summary> Constructs a Primitive with the specified value and specifies whether it should be stored as a number or not. </summary> <param name="value">Value of the Primitive</param> <param name="saveAsNumeric"> Flag, set to true if value should be treated as a number instead of a string </param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.#ctor(System.IO.MemoryStream)"> <summary> Constructs a Binary Primitive with the specified MemoryStream value. Note: Primitive's Value is set to the stream's ToArray() response. </summary> <param name="value">Value of the Primitive</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.#ctor(System.Byte[])"> <summary> Constructs a Binary Primitive with the specified byte[] value. </summary> <param name="value">Value of the Primitive</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsBoolean"> <summary> Explicitly convert Primitive to Boolean </summary> <returns>Boolean value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Boolean)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Boolean to Primitive </summary> <param name="data">Boolean data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Boolean"> <summary> Explicitly convert Primitive to Boolean </summary> <param name="p">Primitive to convert</param> <returns>Boolean value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsByte"> <summary> Explicitly convert Primitive to Byte </summary> <returns>Byte value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Byte)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Byte to Primitive </summary> <param name="data">Byte data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Byte"> <summary> Explicitly convert Primitive to Byte </summary> <param name="p">Primitive to convert</param> <returns>Byte value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsSByte"> <summary> Explicitly convert Primitive to SByte </summary> <returns>SByte value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.SByte)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert SByte to Primitive </summary> <param name="data">SByte data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.SByte"> <summary> Explicitly convert Primitive to SByte </summary> <param name="p">Primitive to convert</param> <returns>SByte value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsUShort"> <summary> Explicitly convert Primitive to UInt16 </summary> <returns>UInt16 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.UInt16)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert UInt16 to Primitive </summary> <param name="data">UInt16 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.UInt16"> <summary> Explicitly convert Primitive to UInt16 </summary> <param name="p">Primitive to convert</param> <returns>UInt16 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsShort"> <summary> Explicitly convert Primitive to Int16 </summary> <returns>Int16 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Int16)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Int16 to Primitive </summary> <param name="data">Int16 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Int16"> <summary> Explicitly convert Primitive to Int16 </summary> <param name="p">Primitive to convert</param> <returns>Int16 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsUInt"> <summary> Explicitly convert Primitive to UInt32 </summary> <returns>UInt32 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.UInt32)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert UInt32 to Primitive </summary> <param name="data">UInt32 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.UInt32"> <summary> Explicitly convert Primitive to UInt32 </summary> <param name="p">Primitive to convert</param> <returns>UInt32 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsInt"> <summary> Explicitly convert Primitive to Int32 </summary> <returns>Int32 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Int32)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Int32 to Primitive </summary> <param name="data">Int32 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Int32"> <summary> Explicitly convert Primitive to Int32 </summary> <param name="p">Primitive to convert</param> <returns>Int32 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsULong"> <summary> Explicitly convert Primitive to UInt64 </summary> <returns>UInt64 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.UInt64)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert UInt64 to Primitive </summary> <param name="data">UInt64 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.UInt64"> <summary> Explicitly convert Primitive to UInt64 </summary> <param name="p">Primitive to convert</param> <returns>UInt64 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsLong"> <summary> Explicitly convert Primitive to Int64 </summary> <returns>Int64 value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Int64)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Int64 to Primitive </summary> <param name="data">Int64 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Int64"> <summary> Explicitly convert Primitive to Int64 </summary> <param name="p">Primitive to convert</param> <returns>Int64 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsSingle"> <summary> Explicitly convert Primitive to Single </summary> <returns>Single value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Single)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Single to Primitive </summary> <param name="data">Single data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Single"> <summary> Explicitly convert Primitive to Single </summary> <param name="p">Primitive to convert</param> <returns>Single value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsDouble"> <summary> Explicitly convert Primitive to Double </summary> <returns>Double value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Double)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Double to Primitive </summary> <param name="data">Double data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Double"> <summary> Explicitly convert Primitive to Double </summary> <param name="p">Primitive to convert</param> <returns>Double value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsDecimal"> <summary> Explicitly convert Primitive to Decimal </summary> <returns>Decimal value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Decimal)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Decimal to Primitive </summary> <param name="data">Decimal data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Decimal"> <summary> Explicitly convert Primitive to Decimal </summary> <param name="p">Primitive to convert</param> <returns>Decimal value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsChar"> <summary> Explicitly convert Primitive to Char </summary> <returns>Char value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Char)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Char to Primitive </summary> <param name="data">Char data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Char"> <summary> Explicitly convert Primitive to Char </summary> <param name="p">Primitive to convert</param> <returns>Char value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsString"> <summary> Explicitly convert Primitive to String </summary> <returns>String value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.String)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert String to Primitive </summary> <param name="data">String data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.String"> <summary> Explicitly convert Primitive to String </summary> <param name="p">Primitive to convert</param> <returns>String value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsDateTime"> <summary> Explicitly convert Primitive to DateTime </summary> <returns>DateTime value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.DateTime)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert DateTime to Primitive </summary> <param name="data">DateTime data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.DateTime"> <summary> Explicitly convert Primitive to DateTime </summary> <param name="p">Primitive to convert</param> <returns>DateTime value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsGuid"> <summary> Explicitly convert Primitive to Guid </summary> <returns>Guid value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Guid)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert Guid to Primitive </summary> <param name="data">Guid data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Guid"> <summary> Explicitly convert Primitive to Guid </summary> <param name="p">Primitive to convert</param> <returns>Guid value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsByteArray"> <summary> Explicitly convert Primitive to byte[] </summary> <returns>byte[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.Byte[])~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert byte[] to Primitive </summary> <param name="data">byte[] data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.Byte[]"> <summary> Explicitly convert Primitive to byte[] </summary> <param name="p">Primitive to convert</param> <returns>byte[] value of Primitive</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.AsMemoryStream"> <summary> Explicitly convert Primitive to MemoryStream </summary> <returns>MemoryStream value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Implicit(System.IO.MemoryStream)~Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> Implicitly convert MemoryStream to Primitive </summary> <param name="data">MemoryStream data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDBv2.DocumentModel.Primitive)~System.IO.MemoryStream"> <summary> Explicitly convert Primitive to MemoryStream </summary> <param name="p">Primitive to convert</param> <returns>MemoryStream value of Primitive</returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Primitive.Value"> <summary> Value of the Primitive. If Type is String or Numeric, this property is a string. If Type is Binary, this property is a byte array. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Primitive.Type"> <summary> Type of this primitive object </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> A DynamoDBEntry that represents a primitive list DynamoDB type </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.#ctor"> <summary> Constructs an empty PrimitiveList. Values are configured to be saved as strings. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.#ctor(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntryType)"> <summary> Constructs an empty PrimitiveList and specifies the type of its elements. </summary> <param name="type"></param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.Add(Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Adds a Primitive to the end of the list. </summary> <param name="value">Primitive to add.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.AsListOfPrimitives"> <summary> Explicitly convert PrimitiveList to List<Primitive> </summary> <returns>List<Primitive> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.Primitive})~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<Primitive> to PrimitiveList </summary> <param name="data">List<Primitive> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.PrimitiveList)~System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.Primitive}"> <summary> Explicitly convert PrimitiveList to List<Primitive> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<Primitive> value of PrimitiveList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.AsListOfString"> <summary> Explicitly convert PrimitiveList to List<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{System.String})~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<String> to PrimitiveList </summary> <param name="data">List<String> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.PrimitiveList)~System.Collections.Generic.List{System.String}"> <summary> Explicitly convert PrimitiveList to List<String> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<String> value of PrimitiveList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.AsListOfByteArray"> <summary> Explicitly convert PrimitiveList to byte[] </summary> <returns>List<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{System.Byte[]})~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<byte[]> to PrimitiveList </summary> <param name="data">List<byte[]> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.PrimitiveList)~System.Collections.Generic.List{System.Byte[]}"> <summary> Explicitly convert PrimitiveList to List<byte[]> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<byte[]> value of PrimitiveList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.AsListOfMemoryStream"> <summary> Explicitly convert PrimitiveList to List<MemoryStream> </summary> <returns>List<MemoryStream> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{System.IO.MemoryStream})~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<MemoryStream> to PrimitiveList </summary> <param name="data">List<MemoryStream> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.PrimitiveList)~System.Collections.Generic.List{System.IO.MemoryStream}"> <summary> Explicitly convert PrimitiveList to List<MemoryStream> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<MemoryStream> value of PrimitiveList</returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.Entries"> <summary> Collection of Primitive entries </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.Type"> <summary> Type of Primitive items in the list </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.Item(System.Int32)"> <summary> Gets or sets Primitive at a specific location in the list. </summary> <param name="i">Index of the Primitive in question.</param> <returns>Primitive in question.</returns> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.Search"> <summary> Search response object </summary> </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.BeginGetNextSet(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetNextSet operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Search.GetNextSet"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetNextSet operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.EndGetNextSet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Search.GetNextSet"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetNextSet.</param> <returns>Next set of Documents matching the search parameters</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.BeginGetRemaining(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRemaining operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Search.GetRemaining"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRemaining operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Search.EndGetRemaining(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRemaining operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Search.GetRemaining"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRemaining.</param> <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.Filter"> <summary> Filter for the search operation </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 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.LoadTable(Amazon.DynamoDBv2.AmazonDynamoDB,System.String)"> <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> <returns>Table object representing the specified table.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryLoadTable(Amazon.DynamoDBv2.AmazonDynamoDB,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. 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.PutItem(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Puts a document into DynamoDB. </summary> <param name="doc">Document to save.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig)"> <summary> Puts a document into DynamoDB, using specified 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.BeginPutItem(Amazon.DynamoDBv2.DocumentModel.Document,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="doc">Document to save.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginPutItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="doc">Document to save.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.EndPutItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.PutItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Null or updated attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Gets a document from DynamoDB by hash primary key. </summary> <param name="hashKey">Hash key element of the document.</param> <returns>Document from DynamoDB</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Gets a document from DynamoDB by hash-and-range primary key. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <returns>Document from DynamoDB.</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})"> <summary> Gets a document from DynamoDB by key. </summary> <param name="key">Values that make up the key of the document.</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.BeginGetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginGetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginGetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginGetItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginGetItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"/> </summary> <param name="key">Key of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginGetItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"/> </summary> <param name="key">Ley of the document.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.EndGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Document from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Update a document in DynamoDB. </summary> <param name="doc">Document to update.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry})"> <summary> Update a document in DynamoDB, with key to identify the document. </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Update a document in DynamoDB, with hash primary key to identify the document. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Update a document in DynamoDB, with a hash-and-range primary key to identify the document. </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> </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.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.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.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.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="doc">Document to update.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="doc">Document to update.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.EndUpdateItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Null or updated attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Delete a document in DynamoDB. </summary> <param name="document">Document to delete.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Delete a document in DynamoDB, identified by a hash primary key. </summary> <param name="hashKey">Hash key element of the document.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive)"> <summary> Delete a document in DynamoDB, identified by a hash-and-range primary key. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry})"> <summary> Delete a document in DynamoDB, identified by a key. </summary> <param name="key">Hash key element of the document.</param> </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> <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.DeleteItem(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>Null or old attributes, depending on config.</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> <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.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> <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.BeginDeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="document">Document to delete.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginDeleteItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="key">Key of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="document">Document to delete.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.BeginDeleteItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.EndDeleteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Null or old attributes, depending on config.</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.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.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.GlobalSecondaryIndexNames"> <summary> Names of the global 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.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.DocumentModel.PutItemOperationConfig"> <summary> Configuration for the Table.PutItem operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig.ExpectedState"> <summary> The expected state of data in DynamoDB. Note: setting both Expected and ExpectedState is not supported and will result in an exception being thrown. For the operation to succeed, the data in DynamoDB must match the conditions specified in the ExpectedState. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig.Expected"> <summary> Document representing the expected state of data in DynamoDB. Note: setting both Expected and ExpectedState is not supported and will result in an exception being thrown. For the operation to succeed, the data in DynamoDB must be equal to the attributes in Expected. If an attribute in Expected is set to null, that attribute must not be preset on the item in DynamoDB. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig.ReturnValues"> <summary> Flag specifying what values should be returned. PutItem only supports ReturnValues.AllOldAttributes and ReturnValues.None </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig"> <summary> Configuration for the Table.GetItem operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig.AttributesToGet"> <summary> List of attributes to retrieve </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.GetItemOperationConfig.ConsistentRead"> <summary> If set to true, this flag ensures that the most recently written data is returned. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"> <summary> Configuration for the Table.UpdateItem operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig.ExpectedState"> <summary> The expected state of data in DynamoDB. Note: setting both Expected and ExpectedState is not supported and will result in an exception being thrown. For the operation to succeed, the data in DynamoDB must match the conditions specified in the ExpectedState. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig.Expected"> <summary> Document representing the expected state of data in DynamoDB. Note: setting both Expected and ExpectedState is not supported and will result in an exception being thrown. For the operation to succeed, the data in DynamoDB must be equal to the attributes in Expected. If an attribute in Expected is set to null, that attribute must not be preset on the item in DynamoDB. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig.ReturnValues"> <summary> Flag specifying what values should be returned. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig"> <summary> Configuration for the Table.DeleteItem operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig.ExpectedState"> <summary> The expected state of data in DynamoDB. Note: setting both Expected and ExpectedState is not supported and will result in an exception being thrown. For the operation to succeed, the data in DynamoDB must match the conditions specified in the ExpectedState. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig.Expected"> <summary> Document representing the expected state of data in DynamoDB. Note: setting both Expected and ExpectedState is not supported and will result in an exception being thrown. For the operation to succeed, the data in DynamoDB must be equal to the attributes in Expected. If an attribute in Expected is set to null, that attribute must not be preset on the item in DynamoDB. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig.ReturnValues"> <summary> Flag specifying what values should be returned. DeleteItem only supports ReturnValues.AllOldAttributes and ReturnValues.None </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig"> <summary> Configuration for the Table.Scan operation </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig.#ctor"> <summary> Initializes a default Table.Scan config object Filter is empty, Limit is Int32.MaxValue </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig.AttributesToGet"> <summary> List of attributes to retrieve as part of the search </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig.Limit"> <summary> Upper limit on the number of items scanned per request for matching conditions. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig.Filter"> <summary> Filter for the search operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig.Select"> <summary> Enum specifying what data to return from query. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig.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.ScanOperationConfig.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.ScanOperationConfig.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.ScanOperationConfig.ConditionalOperator"> <summary> A logical operator to apply to the conditions in the Filter property: AND - If all of the conditions evaluate to true, then the entire filter evaluates to true. OR - If at least one of the conditions evaluate to true, then the entire filter evaluates to true. Default value is AND. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig"> <summary> Configuration for the Table.Query operation </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.#ctor"> <summary> Initializes a default Table.Query config object Filter is empty, Limit is Int32.MaxValue </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.Filter"> <summary> Filter for the search operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.ConsistentRead"> <summary> If set to true, this flag ensures that the most recently written data is returned. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.AttributesToGet"> <summary> List of attributes to retrieve as part of the search </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.Limit"> <summary> Upper limit on the number of items to return per request </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.BackwardSearch"> <summary> Flag that signals if the search is traversing backwards </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.IndexName"> <summary> Name of the index to query against. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.Select"> <summary> Enum specifying what data to return from query. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.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.QueryOperationConfig.ConditionalOperator"> <summary> A logical operator to apply to the conditions in the Filter property: AND - If all of the conditions evaluate to true, then the entire filter evaluates to true. OR - If at least one of the conditions evaluate to true, then the entire filter evaluates to true. Default value is AND. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.ReturnValues"> <summary> An enumeration of all supported return value directives </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.ScanOperator"> <summary> An enumeration of all supported scan operator directives </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.QueryOperator"> <summary> An enumeration of all supported query operator directives </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.SelectValues"> <summary> An enumeration of all supported Select values for Query and Scan. Value of Count will force service to return the number of items, not the items themselves. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.ConditionalOperatorValues"> <summary> An enumeration of all supported ConditionalOperator values. Value of And for an operation will require that all conditions match. Value of Or for an operation will require that at least one of the conditons match. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.AttributeDefinition"> <summary> <para>Represents an attribute for describing the key schema for the table and indexes.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeDefinition.WithAttributeName(System.String)"> <summary> Sets the AttributeName property </summary> <param name="attributeName">The value to set for the AttributeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeDefinition.WithAttributeType(System.String)"> <summary> Sets the AttributeType property </summary> <param name="attributeType">The value to set for the AttributeType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeDefinition.AttributeName"> <summary> A name for the attribute. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeDefinition.AttributeType"> <summary> The data type for the attribute. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>S, N, B</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.AttributeValue"> <summary> <para>Represents the data for an attribute. You can set one, and only one, of the elements.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithS(System.String)"> <summary> Sets the S property </summary> <param name="s">The value to set for the S property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithN(System.String)"> <summary> Sets the N property </summary> <param name="n">The value to set for the N property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithB(System.IO.MemoryStream)"> <summary> Sets the B property </summary> <param name="b">The value to set for the B property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithSS(System.String[])"> <summary> Adds elements to the SS collection </summary> <param name="sS">The values to add to the SS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithSS(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SS collection </summary> <param name="sS">The values to add to the SS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithNS(System.String[])"> <summary> Adds elements to the NS collection </summary> <param name="nS">The values to add to the NS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithNS(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the NS collection </summary> <param name="nS">The values to add to the NS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithBS(System.IO.MemoryStream[])"> <summary> Adds elements to the BS collection </summary> <param name="bS">The values to add to the BS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.WithBS(System.Collections.Generic.IEnumerable{System.IO.MemoryStream})"> <summary> Adds elements to the BS collection </summary> <param name="bS">The values to add to the BS collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.S"> <summary> A String data type </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.N"> <summary> A Number data type </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.B"> <summary> A Binary data type </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.SS"> <summary> A String set data type </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.NS"> <summary> Number set data type </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.BS"> <summary> A Binary set data type </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.AttributeValueUpdate"> <summary> <para>For the <i>UpdateItem</i> operation, represents the attributes to be modified, the action to perform on each, and the new value for each.</para> <para><b>NOTE:</b> You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes. </para> <para>Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> .</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValueUpdate.WithValue(Amazon.DynamoDBv2.Model.AttributeValue)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValueUpdate.WithAction(System.String)"> <summary> Sets the Action property </summary> <param name="action">The value to set for the Action property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValueUpdate.Value"> <summary> Represents the data for an attribute. You can set one, and only one, of the elements. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValueUpdate.Action"> <summary> Specifies how to perform the update. Valid values are <c>PUT</c>, <c>DELETE</c>, and <c>ADD</c>. The behavior depends on whether the specified primary key already exists in the table. <b>If an item with the specified <i>Key</i> is found in the table:</b> <ul> <li> <c>PUT</c> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <c>DELETE</c> - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a <i>set</i> of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <c>[a,b,c]</c> and the <i>DELETE</i> action specified <c>[a,c]</c>, then the final attribute value would be <c>[b]</c>. Specifying an empty set is an error. </li> <li> <c>ADD</c> - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of <c>ADD</c> 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 the <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 <c>ADD</c> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. In addition, if you use <c>ADD</c> to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses <c>0</c> as the initial value. For example, suppose that the item you want to update does not yet have an attribute named <i>itemcount</i>, but you decide to <c>ADD</c> the number <c>3</c> to this attribute anyway, even though it currently does not exist. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <c>0</c>, and finally add <c>3</c> to it. The result will be a new <i>itemcount</i> attribute in the item, with a value of <c>3</c>. </note> </li> <li> If the existing data type is a set, and if the <i>Value</i> is also a set, then the <i>Value</i> is added to the existing set. (This is a <i>set</i> operation, not mathematical addition.) For example, if the attribute value was the set <c>[1,2]</c>, and the <c>ADD</c> action specified <c>[3]</c>, then the final attribute value would be <c>[1,2,3]</c>. An error occurs if an Add 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, the <i>Value</i> must also be a set of strings. The same holds true for number sets and binary sets. </li> </ul> This action is only valid for an existing attribute whose data type is number or is a set. Do not use <c>ADD</c> for any other data types. </li> </ul> <b>If no item with the specified <i>Key</i> is found:</b> <ul> <li> <c>PUT</c> - DynamoDB creates a new item with the specified primary key, and then adds the attribute. </li> <li> <c>DELETE</c> - Nothing happens; there is no attribute to delete. </li> <li> <c>ADD</c> - DynamoDB creates 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; no other data types can be specified. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ADD, PUT, DELETE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchGetItemRequest"> <summary> Container for the parameters to the BatchGetItem operation. <para>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> <para>A single operation can retrieve up to 1 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> <para>For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items (1 MB) and 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 dataset.</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 throw 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> <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 <c>true</c> 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 Amazon DynamoDB Developer Guide.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemRequest.WithRequestItems(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes}[])"> <summary> Adds the KeyValuePairs to the RequestItems dictionary. </summary> <param name="pairs">The pairs to be added to the RequestItems dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemRequest.RequestItems"> <summary> A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once. Each element in the map consists of the following: <ul> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. </li> <li> <i>AttributesToGet</i> - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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> <li> <i>ConsistentRead</i> - If <c>true</c>, a strongly consistent read is used; if <c>false</c> (the default), an eventually consistent read is used. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchGetItemResponse"> <summary> Returns information about the BatchGetItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemResponse.BatchGetItemResult"> <summary> Gets and sets the BatchGetItemResult property. Represents the output of a BatchGetItem operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchGetItemResult"> <summary> <para>Represents the output of a <i>BatchGetItem</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemResult.WithResponses(System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.List{System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue}}}[])"> <summary> Adds the KeyValuePairs to the Responses dictionary. </summary> <param name="pairs">The pairs to be added to the Responses dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemResult.WithUnprocessedKeys(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes}[])"> <summary> Adds the KeyValuePairs to the UnprocessedKeys dictionary. </summary> <param name="pairs">The pairs to be added to the UnprocessedKeys dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity[])"> <summary> Adds elements to the ConsumedCapacity collection </summary> <param name="consumedCapacity">The values to add to the ConsumedCapacity collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemResult.WithConsumedCapacity(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.ConsumedCapacity})"> <summary> Adds elements to the ConsumedCapacity collection </summary> <param name="consumedCapacity">The values to add to the ConsumedCapacity collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemResult.Responses"> <summary> A map of table name to a list of items. Each object in <i>Responses</i> consists of a table name, along with a map of attribute data consisting of the data type and attribute value. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemResult.UnprocessedKeys"> <summary> A map of tables and their respective keys that were not processed with the current response. The <i>UnprocessedKeys</i> value is in the same form as <i>RequestItems</i>, so the value can be provided directly to a subsequent <i>BatchGetItem</i> operation. For more information, see <i>RequestItems</i> in the Request Parameters section. Each element consists of: <ul> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. </li> <li> <i>AttributesToGet</i> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result. </li> <li> <i>ConsistentRead</i> - The consistency of a read operation. If set to <c>true</c>, then a strongly consistent read is used; otherwise, an eventually consistent read is used. </li> </ul> If there are no unprocessed keys remaining, the response contains an empty <i>UnprocessedKeys</i> map. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemResult.ConsumedCapacity"> <summary> The write capacity units consumed by the operation. Each element consists of: <ul> <li> <i>TableName</i> - The table that consumed the provisioned throughput. </li> <li> <i>CapacityUnits</i> - The total number of capacity units consumed. </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchWriteItemRequest"> <summary> Container for the parameters to the BatchWriteItem operation. <para>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 1 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 64 KB.</para> <para><b>NOTE:</b> BatchWriteItem cannot update items. To update items, use the UpdateItem API. </para> <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>BatchGetItem</i> will throw a <i>ProvisionedThroughputExceededException</i> .</para> <para>To write one item, you can use the <i>PutItem</i> operation; to delete one item, you can use the <i>DeleteItem</i> operation.</para> <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, such as Java, 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, such as PHP, 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>The total request size exceeds 1 MB.</para> </li> <li> <para>Any individual item in a batch exceeds 64 KB.</para> </li> </ul> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.WithRequestItems(System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.WriteRequest}}[])"> <summary> Adds the KeyValuePairs to the RequestItems dictionary. </summary> <param name="pairs">The pairs to be added to the RequestItems dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.WithReturnItemCollectionMetrics(System.String)"> <summary> Sets the ReturnItemCollectionMetrics property </summary> <param name="returnItemCollectionMetrics">The value to set for the ReturnItemCollectionMetrics property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.RequestItems"> <summary> 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. </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>. 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> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 25</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.ReturnItemCollectionMetrics"> <summary> If set to <c>SIZE</c>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <c>NONE</c> (the default), no statistics are returned. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>SIZE, NONE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchWriteItemResponse"> <summary> Returns information about the BatchWriteItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemResponse.BatchWriteItemResult"> <summary> Gets and sets the BatchWriteItemResult property. Represents the output of a BatchWriteItem operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchWriteItemResult"> <summary> <para>Represents the output of a <i>BatchWriteItem</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemResult.WithUnprocessedItems(System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.WriteRequest}}[])"> <summary> Adds the KeyValuePairs to the UnprocessedItems dictionary. </summary> <param name="pairs">The pairs to be added to the UnprocessedItems dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemResult.WithItemCollectionMetrics(System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.ItemCollectionMetrics}}[])"> <summary> Adds the KeyValuePairs to the ItemCollectionMetrics dictionary. </summary> <param name="pairs">The pairs to be added to the ItemCollectionMetrics dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity[])"> <summary> Adds elements to the ConsumedCapacity collection </summary> <param name="consumedCapacity">The values to add to the ConsumedCapacity collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemResult.WithConsumedCapacity(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.ConsumedCapacity})"> <summary> Adds elements to the ConsumedCapacity collection </summary> <param name="consumedCapacity">The values to add to the ConsumedCapacity collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemResult.UnprocessedItems"> <summary> A map of tables and requests against those tables that were not processed. The <i>UnprocessedItems</i> value is in the same form as <i>RequestItems</i>, so you can provide this value directly to a subsequent <i>BatchGetItem</i> operation. For more information, see <i>RequestItems</i> in the Request Parameters section. Each <i>UnprocessedItems</i> entry consists of a table name and, for that table, a list of operations to perform (<i>DeleteRequest</i> or <i>PutRequest</i>). <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. </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>. 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> If there are no unprocessed items remaining, the response contains an empty <i>UnprocessedItems</i> map. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 25</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemResult.ItemCollectionMetrics"> <summary> A list of tables that were processed by <i>BatchWriteItem</i> and, for each table, information about any item collections that were affected by individual <i>DeleteItem</i> or <i>PutItem</i> operations. Each entry consists of the following subelements: <ul> <li> <i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as the hash key of the item. </li> <li> <i>SizeEstimateRange</i> - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemResult.ConsumedCapacity"> <summary> The capacity units consumed by the operation. Each element consists of: <ul> <li> <i>TableName</i> - The table that consumed the provisioned throughput. </li> <li> <i>CapacityUnits</i> - The total number of capacity units consumed. </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Capacity"> <summary> <para>Represents the amount of provisioned throughput capacity consumed on a table or an index. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.Capacity.WithCapacityUnits(System.Double)"> <summary> Sets the CapacityUnits property </summary> <param name="capacityUnits">The value to set for the CapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.Capacity.CapacityUnits"> <summary> The total number of capacity units consumed on a table or an index. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Condition"> <summary> <para>Represents the selection criteria for a <i>Query</i> or <i>Scan</i> operation:</para> <ul> <li> <para>For a <i>Query</i> operation, <i>Condition</i> is used for specifying the <i>KeyConditions</i> to use when querying a table or an index. For <i>KeyConditions</i> , the following comparison operators are supported:</para> <para> <c>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</c> </para> <para> <i>Condition</i> is also used in a <i>QueryFilter</i> , which evaluates the query results and returns only the desired values.</para> </li> <li> <para>For a <i>Scan</i> operation, <i>Condition</i> is used in a <i>ScanFilter</i> , which evalues the scan results and returns only the desired values.</para> </li> </ul> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.Condition.WithAttributeValueList(Amazon.DynamoDBv2.Model.AttributeValue[])"> <summary> Adds elements to the AttributeValueList collection </summary> <param name="attributeValueList">The values to add to the AttributeValueList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.Condition.WithAttributeValueList(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Adds elements to the AttributeValueList collection </summary> <param name="attributeValueList">The values to add to the AttributeValueList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.Condition.WithComparisonOperator(System.String)"> <summary> Sets the ComparisonOperator property </summary> <param name="comparisonOperator">The value to set for the ComparisonOperator property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.Condition.AttributeValueList"> <summary> One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used. 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, <c>a</c> is greater than <c>A</c>, and <c>aa</c> is greater than <c>B</c>. 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 example when evaluating query expressions. 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 Amazon DynamoDB Developer Guide. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Condition.ComparisonOperator"> <summary> A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <c>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</c> The following are descriptions of each comparison operator. <ul> <li> <c>EQ</c> : Equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not equal <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>NE</c> : Not equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not equal <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>LE</c> : Less than or equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>LT</c> : Less than. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>GE</c> : Greater than or equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>GT</c> : Greater than. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>NOT_NULL</c> : The attribute exists. </li> <li> <c>NULL</c> : The attribute does not exist. </li> <li> <c>CONTAINS</c> : checks for a subsequence, or value in a set. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring). </li> <li> <c>NOT_CONTAINS</c> : checks for absence of a subsequence, or absence of a value in a set. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring). </li> <li> <c>BEGINS_WITH</c> : checks for a prefix. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set). <p/> </li> <li> <c>IN</c> : checks for exact matches. <i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set. </li> <li> <c>BETWEEN</c> : Greater than or equal to the first value, and less than or equal to the second value. <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not compare to <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c> </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException.#ctor(System.String)"> <summary> Constructs a new ConditionalCheckFailedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.ConsumedCapacity"> <summary> <para>Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html" >Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ConsumedCapacity.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ConsumedCapacity.WithCapacityUnits(System.Double)"> <summary> Sets the CapacityUnits property </summary> <param name="capacityUnits">The value to set for the CapacityUnits property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ConsumedCapacity.WithTable(Amazon.DynamoDBv2.Model.Capacity)"> <summary> Sets the Table property </summary> <param name="table">The value to set for the Table property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ConsumedCapacity.WithLocalSecondaryIndexes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.Capacity}[])"> <summary> Adds the KeyValuePairs to the LocalSecondaryIndexes dictionary. </summary> <param name="pairs">The pairs to be added to the LocalSecondaryIndexes dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ConsumedCapacity.WithGlobalSecondaryIndexes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.Capacity}[])"> <summary> Adds the KeyValuePairs to the GlobalSecondaryIndexes dictionary. </summary> <param name="pairs">The pairs to be added to the GlobalSecondaryIndexes dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.TableName"> <summary> The name of the table that was affected by the operation. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.CapacityUnits"> <summary> The total number of capacity units consumed by the operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.Table"> <summary> The amount of throughput consumed on the table affected by the operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.LocalSecondaryIndexes"> <summary> The amount of throughput consumed on each local index affected by the operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.GlobalSecondaryIndexes"> <summary> The amount of throughput consumed on each global index affected by the operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.CreateTableRequest"> <summary> Container for the parameters to the CreateTable operation. <para>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> <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 <c>CREATING</c> . After the table is created, DynamoDB sets the <i>TableStatus</i> to <c>ACTIVE</c> . You can perform read and write operations only on an <c>ACTIVE</c> table. </para> <para>If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the <c>CREATING</c> state at any given time.</para> <para>You can use the <i>DescribeTable</i> API to check the table status.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithAttributeDefinitions(Amazon.DynamoDBv2.Model.AttributeDefinition[])"> <summary> Adds elements to the AttributeDefinitions collection </summary> <param name="attributeDefinitions">The values to add to the AttributeDefinitions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithAttributeDefinitions(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.AttributeDefinition})"> <summary> Adds elements to the AttributeDefinitions collection </summary> <param name="attributeDefinitions">The values to add to the AttributeDefinitions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithKeySchema(Amazon.DynamoDBv2.Model.KeySchemaElement[])"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithKeySchema(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.KeySchemaElement})"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithLocalSecondaryIndexes(Amazon.DynamoDBv2.Model.LocalSecondaryIndex[])"> <summary> Adds elements to the LocalSecondaryIndexes collection </summary> <param name="localSecondaryIndexes">The values to add to the LocalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithLocalSecondaryIndexes(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.LocalSecondaryIndex})"> <summary> Adds elements to the LocalSecondaryIndexes collection </summary> <param name="localSecondaryIndexes">The values to add to the LocalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithGlobalSecondaryIndexes(Amazon.DynamoDBv2.Model.GlobalSecondaryIndex[])"> <summary> Adds elements to the GlobalSecondaryIndexes collection </summary> <param name="globalSecondaryIndexes">The values to add to the GlobalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithGlobalSecondaryIndexes(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.GlobalSecondaryIndex})"> <summary> Adds elements to the GlobalSecondaryIndexes collection </summary> <param name="globalSecondaryIndexes">The values to add to the GlobalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.WithProvisionedThroughput(Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.AttributeDefinitions"> <summary> An array of attributes that describe the key schema for the table and indexes. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.TableName"> <summary> The name of the table to create. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.KeySchema"> <summary> 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 Amazon DynamoDB Developer Guide. 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> - Determines whether the key attribute is <c>HASH</c> or <c>RANGE</c>. </li> </ul> For a primary key that consists of a hash attribute, you must specify exactly one element with a <i>KeyType</i> of <c>HASH</c>. For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a <i>KeyType</i> of <c>HASH</c>, and the second element must have a <i>KeyType</i> of <c>RANGE</c>. 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 Amazon DynamoDB Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.LocalSecondaryIndexes"> <summary> One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 GB size limit per hash key; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following: <ul> <li> <i>IndexName</i> - The name of the local secondary index. Must be unique only for this table. <p/> </li> <li> <i>KeySchema</i> - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table. </li> <li> <i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: <ul> <li> <i>ProjectionType</i> - One of the following: <ul> <li> <c>KEYS_ONLY</c> - Only the index and primary keys are projected into the index. </li> <li> <c>INCLUDE</c> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </li> <li> <c>ALL</c> - All of the table attributes are projected into the index. </li> </ul> </li> <li> <i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. </li> </ul> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.GlobalSecondaryIndexes"> <summary> One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following: <ul> <li> <i>IndexName</i> - The name of the global secondary index. Must be unique only for this table. <p/> </li> <li> <i>KeySchema</i> - Specifies the key schema for the global secondary index. </li> <li> <i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: <ul> <li> <i>ProjectionType</i> - One of the following: <ul> <li> <c>KEYS_ONLY</c> - Only the index and primary keys are projected into the index. </li> <li> <c>INCLUDE</c> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </li> <li> <c>ALL</c> - All of the table attributes are projected into the index. </li> </ul> </li> <li> <i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. </li> </ul> </li> <li> <i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.ProvisionedThroughput"> <summary> Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the <i>UpdateTable</i> operation. For current minimum and maximum provisioned throughput values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.CreateTableResponse"> <summary> Returns information about the CreateTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableResponse.CreateTableResult"> <summary> Gets and sets the CreateTableResult property. Represents the output of a CreateTable operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.CreateTableResult"> <summary> <para>Represents the output of a <i>CreateTable</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableResult.WithTableDescription(Amazon.DynamoDBv2.Model.TableDescription)"> <summary> Sets the TableDescription property </summary> <param name="tableDescription">The value to set for the TableDescription property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableResult.TableDescription"> <summary> Represents the properties of a table. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteItemRequest"> <summary> Container for the parameters to the DeleteItem operation. <para>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> <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 only deleting items if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.WithKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Key dictionary. </summary> <param name="pairs">The pairs to be added to the Key dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.WithExpected(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.ExpectedAttributeValue}[])"> <summary> Adds the KeyValuePairs to the Expected dictionary. </summary> <param name="pairs">The pairs to be added to the Expected dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.WithConditionalOperator(System.String)"> <summary> Sets the ConditionalOperator property </summary> <param name="conditionalOperator">The value to set for the ConditionalOperator property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.WithReturnValues(System.String)"> <summary> Sets the ReturnValues property </summary> <param name="returnValues">The value to set for the ReturnValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.WithReturnItemCollectionMetrics(System.String)"> <summary> Sets the ReturnItemCollectionMetrics property </summary> <param name="returnItemCollectionMetrics">The value to set for the ReturnItemCollectionMetrics property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.TableName"> <summary> The name of the table from which to delete the item. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.Key"> <summary> A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.Expected"> <summary> A map of attribute/condition pairs. This is the conditional block for the <i>DeleteItem</i> operation. <i>Expected</i> allows you to provide an attribute name, and whether or not DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it. Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with the following: <ul> <li> <i>Value</i> - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used. </li> <li> <i>Exists</i> - Causes DynamoDB to evaluate the value before attempting a conditional operation: <ul> <li> If <i>Exists</i> is <c>true</c>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> <li> If <i>Exists</i> is <c>false</c>, DynamoDB assumes that the attribute value does <i>not</i> exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> </ul> The default setting for <i>Exists</i> is <c>true</c>. If you supply a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <c>true</c>, because it is implied. DynamoDB returns a <i>ValidationException</i> if: <ul> <li> <i>Exists</i> is <c>true</c> but there is no <i>Value</i> to check. (You expect a value to exist, but don't specify what that value is.) </li> <li> <i>Exists</i> is <c>false</c> but you also specify a <i>Value</i>. (You cannot expect an attribute to have a value, while also expecting it not to exist.) </li> </ul> </li> </ul> If you specify more than one condition in the <i>Expected</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.) If <i>Expected</i> evaluates to true, then the conditional operation succeeds; otherwise, it fails. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ConditionalOperator"> <summary> A logical operator to apply to the conditions in the <i>Expected</i> map: <ul> <li><c>AND</c> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> <li><c>OR</c> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> </ul> If you omit <i>ConditionalOperator</i>, then <c>AND</c> is used as the default. The operation will succeed only if the entire map evaluates to true. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>AND, OR</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnValues"> <summary> 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> <c>NONE</c> - If <i>ReturnValues</i> is not specified, or if its value is <c>NONE</c>, then nothing is returned. (This is the default for <i>ReturnValues</i>.) </li> <li> <c>ALL_OLD</c> - The content of the old item is returned. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnItemCollectionMetrics"> <summary> If set to <c>SIZE</c>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <c>NONE</c> (the default), no statistics are returned. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>SIZE, NONE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteItemResponse"> <summary> Returns information about the DeleteItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemResponse.DeleteItemResult"> <summary> Gets and sets the DeleteItemResult property. Represents the output of a DeleteItem operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteItemResult"> <summary> <para>Represents the output of a <i>DeleteItem</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemResult.WithAttributes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Attributes dictionary. </summary> <param name="pairs">The pairs to be added to the Attributes dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity)"> <summary> Sets the ConsumedCapacity property </summary> <param name="consumedCapacity">The value to set for the ConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemResult.WithItemCollectionMetrics(Amazon.DynamoDBv2.Model.ItemCollectionMetrics)"> <summary> Sets the ItemCollectionMetrics property </summary> <param name="itemCollectionMetrics">The value to set for the ItemCollectionMetrics property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemResult.Attributes"> <summary> A map of attribute names to <i>AttributeValue</i> objects, representing the item as it appeared before the <i>DeleteItem</i> operation. This map appears in the response only if <i>ReturnValues</i> was specified as <c>ALL_OLD</c> in the request. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemResult.ConsumedCapacity"> <summary> Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemResult.ItemCollectionMetrics"> <summary> Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the table does not have any local secondary indexes, this information is not returned in the response. Each <i>ItemCollectionMetrics</i> element consists of: <ul> <li><i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as the hash key of the item.</li> <li><i>SizeEstimateRange</i> - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteRequest"> <summary> <para>Represents a request to perform a <i>DeleteItem</i> operation on an item.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteRequest.WithKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Key dictionary. </summary> <param name="pairs">The pairs to be added to the Key dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteRequest.Key"> <summary> A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteTableRequest"> <summary> Container for the parameters to the DeleteTable operation. <para>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 <c>DELETING</c> state until DynamoDB completes the deletion. If the table is in the <c>ACTIVE</c> state, you can delete it. If a table is in <c>CREATING</c> or <c>UPDATING</c> 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 <c>DELETING</c> state, no error is returned. </para> <para><b>NOTE:</b> DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. </para> <para>When you delete a table, any indexes on that table are also deleted.</para> <para>Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteTableRequest.TableName"> <summary> The name of the table to delete. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteTableResponse"> <summary> Returns information about the DeleteTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteTableResponse.DeleteTableResult"> <summary> Gets and sets the DeleteTableResult property. Represents the output of a DeleteTable operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteTableResult"> <summary> <para>Represents the output of a <i>DeleteTable</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteTableResult.WithTableDescription(Amazon.DynamoDBv2.Model.TableDescription)"> <summary> Sets the TableDescription property </summary> <param name="tableDescription">The value to set for the TableDescription property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteTableResult.TableDescription"> <summary> Represents the properties of a table. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeTableRequest"> <summary> Container for the parameters to the DescribeTable operation. <para>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.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.DescribeTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeTableRequest.TableName"> <summary> The name of the table to describe. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeTableResponse"> <summary> Returns information about the DescribeTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeTableResponse.DescribeTableResult"> <summary> Gets and sets the DescribeTableResult property. Represents the output of a DescribeTable operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeTableResult"> <summary> <para>Represents the output of a <i>DescribeTable</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DescribeTableResult.WithTable(Amazon.DynamoDBv2.Model.TableDescription)"> <summary> Sets the Table property </summary> <param name="table">The value to set for the Table property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeTableResult.Table"> <summary> Represents the properties of a table. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ExpectedAttributeValue"> <summary> <para>Represents an attribute value used with conditional <i>DeleteItem</i> , <i>PutItem</i> or <i>UpdateItem</i> operations. DynamoDB will check to see if the attribute value already exists; or if the attribute exists and has a particular value before updating it.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.WithValue(Amazon.DynamoDBv2.Model.AttributeValue)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.WithExists(System.Boolean)"> <summary> Sets the Exists property </summary> <param name="exists">The value to set for the Exists property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.WithComparisonOperator(System.String)"> <summary> Sets the ComparisonOperator property </summary> <param name="comparisonOperator">The value to set for the ComparisonOperator property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.WithAttributeValueList(Amazon.DynamoDBv2.Model.AttributeValue[])"> <summary> Adds elements to the AttributeValueList collection </summary> <param name="attributeValueList">The values to add to the AttributeValueList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.WithAttributeValueList(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Adds elements to the AttributeValueList collection </summary> <param name="attributeValueList">The values to add to the AttributeValueList collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.Value"> <summary> Represents the data for an attribute. You can set one, and only one, of the elements. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.Exists"> <summary> Causes DynamoDB to evaluate the value before attempting a conditional operation: <ul> <li> If <i>Exists</i> is <c>true</c>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> <li> If <i>Exists</i> is <c>false</c>, DynamoDB assumes that the attribute value does <i>not</i> exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> </ul> The default setting for <i>Exists</i> is <c>true</c>. If you supply a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <c>true</c>, because it is implied. DynamoDB returns a <i>ValidationException</i> if: <ul> <li> <i>Exists</i> is <c>true</c> but there is no <i>Value</i> to check. (You expect a value to exist, but don't specify what that value is.) </li> <li> <i>Exists</i> is <c>false</c> but you also specify a <i>Value</i>. (You cannot expect an attribute to have a value, while also expecting it not to exist.) </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.ComparisonOperator"> <summary> A comparator for evaluating attributes in the <i>AttributeValueList</i>. For example, equals, greater than, less than, etc. The following comparison operators are available: <c>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</c> <note>You cannot specify <i>ComparisonOperator</i> if <i>Exists</i> or <i>Value</i> are also present.</note> The following are descriptions of each comparison operator. <ul> <li> <c>EQ</c> : Equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not equal <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>NE</c> : Not equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not equal <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>LE</c> : Less than or equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>LT</c> : Less than. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>GE</c> : Greater than or equal. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>GT</c> : Greater than. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not equal <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c>. <p/> </li> <li> <c>NOT_NULL</c> : The attribute exists. </li> <li> <c>NULL</c> : The attribute does not exist. </li> <li> <c>CONTAINS</c> : checks for a subsequence, or value in a set. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for a member of the set (not as a substring). </li> <li> <c>NOT_CONTAINS</c> : checks for absence of a subsequence, or absence of a value in a set. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operation checks for the absence of a member of the set (not as a substring). </li> <li> <c>BEGINS_WITH</c> : checks for a prefix. <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set). <p/> </li> <li> <c>IN</c> : checks for exact matches. <i>AttributeValueList</i> can contain more than one <i>AttributeValue</i> of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set. </li> <li> <c>BETWEEN</c> : Greater than or equal to the first value, and less than or equal to the second value. <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an <i>AttributeValue</i> of a different type than the one specified in the request, the value does not match. For example, <c>{"S":"6"}</c> does not compare to <c>{"N":"6"}</c>. Also, <c>{"N":"6"}</c> does not compare to <c>{"NS":["6", "2", "1"]}</c> </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.AttributeValueList"> <summary> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the <i>ComparisonOperator</i> being used. 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, <c>a</c> is greater than <c>A</c>, and <c>aa</c> is greater than <c>B</c>. 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 example when evaluating query expressions. 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 Amazon DynamoDB Developer Guide. <note>You cannot specify <i>AttributeValueList</i> if <i>Exists</i> or <i>Value</i> are also present.</note> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetItemRequest"> <summary> Container for the parameters to the GetItem operation. <para>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> <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <c>true</c> . Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.WithKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Key dictionary. </summary> <param name="pairs">The pairs to be added to the Key dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.WithConsistentRead(System.Boolean)"> <summary> Sets the ConsistentRead property </summary> <param name="consistentRead">The value to set for the ConsistentRead property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.TableName"> <summary> The name of the table containing the requested item. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.Key"> <summary> A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.AttributesToGet"> <summary> The names of one or more attributes to retrieve. 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. 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. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.ConsistentRead"> <summary> If set to <c>true</c>, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetItemResponse"> <summary> Returns information about the GetItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemResponse.GetItemResult"> <summary> Gets and sets the GetItemResult property. Represents the output of a GetItem operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetItemResult"> <summary> <para>Represents the output of a <i>GetItem</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemResult.WithItem(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Item dictionary. </summary> <param name="pairs">The pairs to be added to the Item dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity)"> <summary> Sets the ConsumedCapacity property </summary> <param name="consumedCapacity">The value to set for the ConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemResult.Item"> <summary> A map of attribute names to <i>AttributeValue</i> objects, as specified by <i>AttributesToGet</i>. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemResult.ConsumedCapacity"> <summary> Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex"> <summary> <para>Represents a global secondary index.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.WithIndexName(System.String)"> <summary> Sets the IndexName property </summary> <param name="indexName">The value to set for the IndexName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.WithKeySchema(Amazon.DynamoDBv2.Model.KeySchemaElement[])"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.WithKeySchema(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.KeySchemaElement})"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.WithProjection(Amazon.DynamoDBv2.Model.Projection)"> <summary> Sets the Projection property </summary> <param name="projection">The value to set for the Projection property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.WithProvisionedThroughput(Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.IndexName"> <summary> The name of the global secondary index. The name must be unique among all other indexes on this table. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.KeySchema"> <summary> The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types (<c>HASH</c> or <c>RANGE</c>). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.Projection"> <summary> Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.ProvisionedThroughput"> <summary> Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the <i>UpdateTable</i> operation. For current minimum and maximum provisioned throughput values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription"> <summary> <para>Represents the properties of a global secondary index.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithIndexName(System.String)"> <summary> Sets the IndexName property </summary> <param name="indexName">The value to set for the IndexName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithKeySchema(Amazon.DynamoDBv2.Model.KeySchemaElement[])"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithKeySchema(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.KeySchemaElement})"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithProjection(Amazon.DynamoDBv2.Model.Projection)"> <summary> Sets the Projection property </summary> <param name="projection">The value to set for the Projection property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithIndexStatus(System.String)"> <summary> Sets the IndexStatus property </summary> <param name="indexStatus">The value to set for the IndexStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithProvisionedThroughput(Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithIndexSizeBytes(System.Int64)"> <summary> Sets the IndexSizeBytes property </summary> <param name="indexSizeBytes">The value to set for the IndexSizeBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.WithItemCount(System.Int64)"> <summary> Sets the ItemCount property </summary> <param name="itemCount">The value to set for the ItemCount property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.IndexName"> <summary> The name of the global secondary index. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.KeySchema"> <summary> The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types (<c>HASH</c> or <c>RANGE</c>). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.Projection"> <summary> Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.IndexStatus"> <summary> The current state of the global secondary index: <ul> <li> <i>CREATING</i> - The index is being created, as the result of a <i>CreateTable</i> or <i>UpdateTable</i> operation. </li> <li> <i>UPDATING</i> - The index is being updated, as the result of a <i>CreateTable</i> or <i>UpdateTable</i> operation. </li> <li> <i>DELETING</i> - The index is being deleted, as the result of a <i>DeleteTable</i> operation. </li> <li> <i>ACTIVE</i> - The index is ready for use. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATING, UPDATING, DELETING, ACTIVE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.ProvisionedThroughput"> <summary> Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.IndexSizeBytes"> <summary> The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.ItemCount"> <summary> The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate"> <summary> <para>Represents the new provisioned throughput settings to apply to a global secondary index.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate.WithUpdate(Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction)"> <summary> Sets the Update property </summary> <param name="update">The value to set for the Update property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate.Update"> <summary> The name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.InternalServerErrorException.#ctor(System.String)"> <summary> Constructs a new InternalServerErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.AttributeDefinitionUnmarshaller"> <summary> AttributeDefinitionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.AttributeValueUnmarshaller"> <summary> AttributeValueUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.BatchGetItemRequestMarshaller"> <summary> Batch Get Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.BatchGetItemResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetItem operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.BatchGetItemResultUnmarshaller"> <summary> BatchGetItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.BatchWriteItemRequestMarshaller"> <summary> Batch Write Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.BatchWriteItemResponseUnmarshaller"> <summary> Response Unmarshaller for BatchWriteItem operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.BatchWriteItemResultUnmarshaller"> <summary> BatchWriteItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.CapacityUnmarshaller"> <summary> CapacityUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ConsumedCapacityUnmarshaller"> <summary> ConsumedCapacityUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.CreateTableRequestMarshaller"> <summary> Create Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.CreateTableResponseUnmarshaller"> <summary> Response Unmarshaller for CreateTable operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.CreateTableResultUnmarshaller"> <summary> CreateTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteItemRequestMarshaller"> <summary> Delete Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteItemResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteItem operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteItemResultUnmarshaller"> <summary> DeleteItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteRequestUnmarshaller"> <summary> DeleteRequestUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteTableRequestMarshaller"> <summary> Delete Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteTableResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteTable operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteTableResultUnmarshaller"> <summary> DeleteTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DescribeTableRequestMarshaller"> <summary> Describe Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DescribeTableResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTable operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DescribeTableResultUnmarshaller"> <summary> DescribeTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GetItemRequestMarshaller"> <summary> Get Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GetItemResponseUnmarshaller"> <summary> Response Unmarshaller for GetItem operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GetItemResultUnmarshaller"> <summary> GetItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GlobalSecondaryIndexDescriptionUnmarshaller"> <summary> GlobalSecondaryIndexDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ItemCollectionMetricsUnmarshaller"> <summary> ItemCollectionMetricsUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.KeysAndAttributesUnmarshaller"> <summary> KeysAndAttributesUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.KeySchemaElementUnmarshaller"> <summary> KeySchemaElementUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ListTablesRequestMarshaller"> <summary> List Tables Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ListTablesResponseUnmarshaller"> <summary> Response Unmarshaller for ListTables operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ListTablesResultUnmarshaller"> <summary> ListTablesResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.LocalSecondaryIndexDescriptionUnmarshaller"> <summary> LocalSecondaryIndexDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ProjectionUnmarshaller"> <summary> ProjectionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ProvisionedThroughputDescriptionUnmarshaller"> <summary> ProvisionedThroughputDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.PutItemRequestMarshaller"> <summary> Put Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.PutItemResponseUnmarshaller"> <summary> Response Unmarshaller for PutItem operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.PutItemResultUnmarshaller"> <summary> PutItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.PutRequestUnmarshaller"> <summary> PutRequestUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.QueryRequestMarshaller"> <summary> Query Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.QueryResponseUnmarshaller"> <summary> Response Unmarshaller for Query operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.QueryResultUnmarshaller"> <summary> QueryResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ScanRequestMarshaller"> <summary> Scan Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ScanResponseUnmarshaller"> <summary> Response Unmarshaller for Scan operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ScanResultUnmarshaller"> <summary> ScanResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.TableDescriptionUnmarshaller"> <summary> TableDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateItemRequestMarshaller"> <summary> Update Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateItemResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateItem operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateItemResultUnmarshaller"> <summary> UpdateItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateTableRequestMarshaller"> <summary> Update Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateTableResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateTable operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateTableResultUnmarshaller"> <summary> UpdateTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.WriteRequestUnmarshaller"> <summary> WriteRequestUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ItemCollectionMetrics"> <summary> <para>Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the table does not have any local secondary indexes, this information is not returned in the response.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ItemCollectionMetrics.WithItemCollectionKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the ItemCollectionKey dictionary. </summary> <param name="pairs">The pairs to be added to the ItemCollectionKey dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ItemCollectionMetrics.WithSizeEstimateRangeGB(System.Double[])"> <summary> Adds elements to the SizeEstimateRangeGB collection </summary> <param name="sizeEstimateRangeGB">The values to add to the SizeEstimateRangeGB collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ItemCollectionMetrics.WithSizeEstimateRangeGB(System.Collections.Generic.IEnumerable{System.Double})"> <summary> Adds elements to the SizeEstimateRangeGB collection </summary> <param name="sizeEstimateRangeGB">The values to add to the SizeEstimateRangeGB collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ItemCollectionMetrics.ItemCollectionKey"> <summary> The hash key value of the item collection. This is the same as the hash key of the item. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ItemCollectionMetrics.SizeEstimateRangeGB"> <summary> An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException.#ctor(System.String)"> <summary> Constructs a new ItemCollectionSizeLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.KeysAndAttributes"> <summary> <para>Represents a set of primary keys and, for each key, the attributes to retrieve from the table.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.KeysAndAttributes.WithKeys(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds elements to the Keys collection </summary> <param name="keys">The values to add to the Keys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.KeysAndAttributes.WithKeys(System.Collections.Generic.IEnumerable{System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue}})"> <summary> Adds elements to the Keys collection </summary> <param name="keys">The values to add to the Keys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.KeysAndAttributes.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.KeysAndAttributes.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.KeysAndAttributes.WithConsistentRead(System.Boolean)"> <summary> Sets the ConsistentRead property </summary> <param name="consistentRead">The value to set for the ConsistentRead property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.Keys"> <summary> The primary key attribute values that define the items and the attributes associated with the items. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.AttributesToGet"> <summary> One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.ConsistentRead"> <summary> The consistency of a read operation. If set to <c>true</c>, then a strongly consistent read is used; otherwise, an eventually consistent read is used. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.KeySchemaElement"> <summary> <para>Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.KeySchemaElement.WithAttributeName(System.String)"> <summary> Sets the AttributeName property </summary> <param name="attributeName">The value to set for the AttributeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.KeySchemaElement.WithKeyType(System.String)"> <summary> Sets the KeyType property </summary> <param name="keyType">The value to set for the KeyType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.KeySchemaElement.AttributeName"> <summary> The name of a key attribute. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeySchemaElement.KeyType"> <summary> The attribute data, consisting of the data type and the attribute value itself. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>HASH, RANGE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.LimitExceededException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.ListTablesRequest"> <summary> Container for the parameters to the ListTables operation. <para>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.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesRequest.WithExclusiveStartTableName(System.String)"> <summary> Sets the ExclusiveStartTableName property </summary> <param name="exclusiveStartTableName">The value to set for the ExclusiveStartTableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesRequest.ExclusiveStartTableName"> <summary> 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. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesRequest.Limit"> <summary> A maximum number of table names to return. If this parameter is not specified, the limit is 100. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ListTablesResponse"> <summary> Returns information about the ListTablesResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesResponse.ListTablesResult"> <summary> Gets and sets the ListTablesResult property. Represents the output of a ListTables operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ListTablesResult"> <summary> <para>Represents the output of a <i>ListTables</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesResult.WithTableNames(System.String[])"> <summary> Adds elements to the TableNames collection </summary> <param name="tableNames">The values to add to the TableNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesResult.WithTableNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the TableNames collection </summary> <param name="tableNames">The values to add to the TableNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesResult.WithLastEvaluatedTableName(System.String)"> <summary> Sets the LastEvaluatedTableName property </summary> <param name="lastEvaluatedTableName">The value to set for the LastEvaluatedTableName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesResult.TableNames"> <summary> The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If <i>LastEvaluatedTableName</i> also appears in the output, you can use this value as the <i>ExclusiveStartTableName</i> parameter in a subsequent <i>ListTables</i> request and obtain the next page of results. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesResult.LastEvaluatedTableName"> <summary> The name of the last table in the current page of results. Use this value as the <i>ExclusiveStartTableName</i> in a new request to obtain the next page of results, until all the table names are returned. If you do not receive a <i>LastEvaluatedTableName</i> value in the response, this means that there are no more table names to be retrieved. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.LocalSecondaryIndex"> <summary> <para>Represents a local secondary index.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.WithIndexName(System.String)"> <summary> Sets the IndexName property </summary> <param name="indexName">The value to set for the IndexName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.WithKeySchema(Amazon.DynamoDBv2.Model.KeySchemaElement[])"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.WithKeySchema(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.KeySchemaElement})"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.WithProjection(Amazon.DynamoDBv2.Model.Projection)"> <summary> Sets the Projection property </summary> <param name="projection">The value to set for the Projection property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.IndexName"> <summary> The name of the local secondary index. The name must be unique among all other indexes on this table. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.KeySchema"> <summary> The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types (<c>HASH</c> or <c>RANGE</c>). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.Projection"> <summary> Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription"> <summary> <para>Represents the properties of a local secondary index.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.WithIndexName(System.String)"> <summary> Sets the IndexName property </summary> <param name="indexName">The value to set for the IndexName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.WithKeySchema(Amazon.DynamoDBv2.Model.KeySchemaElement[])"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.WithKeySchema(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.KeySchemaElement})"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.WithProjection(Amazon.DynamoDBv2.Model.Projection)"> <summary> Sets the Projection property </summary> <param name="projection">The value to set for the Projection property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.WithIndexSizeBytes(System.Int64)"> <summary> Sets the IndexSizeBytes property </summary> <param name="indexSizeBytes">The value to set for the IndexSizeBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.WithItemCount(System.Int64)"> <summary> Sets the ItemCount property </summary> <param name="itemCount">The value to set for the ItemCount property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.IndexName"> <summary> Represents the name of the local secondary index. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.KeySchema"> <summary> The complete index key schema, which consists of one or more pairs of attribute names and key types (<c>HASH</c> or <c>RANGE</c>). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.Projection"> <summary> Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.IndexSizeBytes"> <summary> The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.ItemCount"> <summary> The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Projection"> <summary> <para>Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.Projection.WithProjectionType(System.String)"> <summary> Sets the ProjectionType property </summary> <param name="projectionType">The value to set for the ProjectionType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.Projection.WithNonKeyAttributes(System.String[])"> <summary> Adds elements to the NonKeyAttributes collection </summary> <param name="nonKeyAttributes">The values to add to the NonKeyAttributes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.Projection.WithNonKeyAttributes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the NonKeyAttributes collection </summary> <param name="nonKeyAttributes">The values to add to the NonKeyAttributes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.Projection.ProjectionType"> <summary> The set of attributes that are projected into the index: <ul> <li> <c>KEYS_ONLY</c> - Only the index and primary keys are projected into the index. </li> <li> <c>INCLUDE</c> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </li> <li> <c>ALL</c> - All of the table attributes are projected into the index. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ALL, KEYS_ONLY, INCLUDE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Projection.NonKeyAttributes"> <summary> Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of <i>NonKeyAttributes</i> summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 20</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ProvisionedThroughput"> <summary> <para>Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the <i>UpdateTable</i> operation.</para> <para>For current minimum and maximum provisioned throughput values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html" >Limits</a> in the Amazon DynamoDB Developer Guide.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughput.WithReadCapacityUnits(System.Int64)"> <summary> Sets the ReadCapacityUnits property </summary> <param name="readCapacityUnits">The value to set for the ReadCapacityUnits property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughput.WithWriteCapacityUnits(System.Int64)"> <summary> Sets the WriteCapacityUnits property </summary> <param name="writeCapacityUnits">The value to set for the WriteCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughput.ReadCapacityUnits"> <summary> The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the Amazon DynamoDB Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughput.WriteCapacityUnits"> <summary> The maximum number of writes consumed per second before DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the Amazon DynamoDB Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription"> <summary> <para>Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.WithLastIncreaseDateTime(System.DateTime)"> <summary> Sets the LastIncreaseDateTime property </summary> <param name="lastIncreaseDateTime">The value to set for the LastIncreaseDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.WithLastDecreaseDateTime(System.DateTime)"> <summary> Sets the LastDecreaseDateTime property </summary> <param name="lastDecreaseDateTime">The value to set for the LastDecreaseDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.WithNumberOfDecreasesToday(System.Int64)"> <summary> Sets the NumberOfDecreasesToday property </summary> <param name="numberOfDecreasesToday">The value to set for the NumberOfDecreasesToday property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.WithReadCapacityUnits(System.Int64)"> <summary> Sets the ReadCapacityUnits property </summary> <param name="readCapacityUnits">The value to set for the ReadCapacityUnits property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.WithWriteCapacityUnits(System.Int64)"> <summary> Sets the WriteCapacityUnits property </summary> <param name="writeCapacityUnits">The value to set for the WriteCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.LastIncreaseDateTime"> <summary> The date and time of the last provisioned throughput increase for this table. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.LastDecreaseDateTime"> <summary> The date and time of the last provisioned throughput decrease for this table. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.NumberOfDecreasesToday"> <summary> The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> in the Amazon DynamoDB Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.ReadCapacityUnits"> <summary> The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <i>ThrottlingException</i>. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 <i>ReadCapacityUnits</i> per second provides 100 eventually consistent <i>ReadCapacityUnits</i> per second. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.WriteCapacityUnits"> <summary> The maximum number of writes consumed per second before DynamoDB returns a <i>ThrottlingException</i>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException.#ctor(System.String)"> <summary> Constructs a new ProvisionedThroughputExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.PutItemRequest"> <summary> Container for the parameters to the PutItem operation. <para>Creates a new item, or replaces an old item with a new item. If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert 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> <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> .</para> <para>You can request that <i>PutItem</i> return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the <i>ReturnValues</i> description.</para> <para><b>NOTE:</b> To prevent a new item from replacing an existing item, use a conditional put operation with Exists set to false for the primary key attribute, or attributes. </para> <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 Amazon DynamoDB Developer Guide.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.WithItem(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Item dictionary. </summary> <param name="pairs">The pairs to be added to the Item dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.WithExpected(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.ExpectedAttributeValue}[])"> <summary> Adds the KeyValuePairs to the Expected dictionary. </summary> <param name="pairs">The pairs to be added to the Expected dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.WithReturnValues(System.String)"> <summary> Sets the ReturnValues property </summary> <param name="returnValues">The value to set for the ReturnValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.WithReturnItemCollectionMetrics(System.String)"> <summary> Sets the ReturnItemCollectionMetrics property </summary> <param name="returnItemCollectionMetrics">The value to set for the ReturnItemCollectionMetrics property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.WithConditionalOperator(System.String)"> <summary> Sets the ConditionalOperator property </summary> <param name="conditionalOperator">The value to set for the ConditionalOperator property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.TableName"> <summary> The name of the table to contain the item. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.Item"> <summary> 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. 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 Amazon DynamoDB Developer Guide. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.Expected"> <summary> A map of attribute/condition pairs. This is the conditional block for the <i>PutItem</i> operation. <i>Expected</i> allows you to provide an attribute name, and whether or not DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it. Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with the following: <ul> <li> <i>Value</i> - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used. </li> <li> <i>Exists</i> - Causes DynamoDB to evaluate the value before attempting a conditional operation: <ul> <li> If <i>Exists</i> is <c>true</c>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> <li> If <i>Exists</i> is <c>false</c>, DynamoDB assumes that the attribute value does <i>not</i> exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> </ul> The default setting for <i>Exists</i> is <c>true</c>. If you supply a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <c>true</c>, because it is implied. DynamoDB returns a <i>ValidationException</i> if: <ul> <li> <i>Exists</i> is <c>true</c> but there is no <i>Value</i> to check. (You expect a value to exist, but don't specify what that value is.) </li> <li> <i>Exists</i> is <c>false</c> but you also specify a <i>Value</i>. (You cannot expect an attribute to have a value, while also expecting it not to exist.) </li> </ul> </li> </ul> If you specify more than one condition in the <i>Expected</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.) If <i>Expected</i> evaluates to true, then the conditional operation succeeds; otherwise, it fails. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ReturnValues"> <summary> 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> <c>NONE</c> - If <i>ReturnValues</i> is not specified, or if its value is <c>NONE</c>, then nothing is returned. (This is the default for <i>ReturnValues</i>.) </li> <li> <c>ALL_OLD</c> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ReturnItemCollectionMetrics"> <summary> If set to <c>SIZE</c>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <c>NONE</c> (the default), no statistics are returned. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>SIZE, NONE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ConditionalOperator"> <summary> A logical operator to apply to the conditions in the <i>Expected</i> map: <ul> <li><c>AND</c> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> <li><c>OR</c> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> </ul> If you omit <i>ConditionalOperator</i>, then <c>AND</c> is used as the default. The operation will succeed only if the entire map evaluates to true. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>AND, OR</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.PutItemResponse"> <summary> Returns information about the PutItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemResponse.PutItemResult"> <summary> Gets and sets the PutItemResult property. Represents the output of a PutItem operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.PutItemResult"> <summary> <para>Represents the output of a <i>PutItem</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemResult.WithAttributes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Attributes dictionary. </summary> <param name="pairs">The pairs to be added to the Attributes dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity)"> <summary> Sets the ConsumedCapacity property </summary> <param name="consumedCapacity">The value to set for the ConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemResult.WithItemCollectionMetrics(Amazon.DynamoDBv2.Model.ItemCollectionMetrics)"> <summary> Sets the ItemCollectionMetrics property </summary> <param name="itemCollectionMetrics">The value to set for the ItemCollectionMetrics property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemResult.Attributes"> <summary> The attribute values as they appeared before the <i>PutItem</i> operation, but only if <i>ReturnValues</i> is specified as <c>ALL_OLD</c> in the request. Each element consists of an attribute name and an attribute value. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemResult.ConsumedCapacity"> <summary> Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemResult.ItemCollectionMetrics"> <summary> Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the table does not have any local secondary indexes, this information is not returned in the response. Each <i>ItemCollectionMetrics</i> element consists of: <ul> <li><i>ItemCollectionKey</i> - The hash key value of the item collection. This is the same as the hash key of the item.</li> <li><i>SizeEstimateRange</i> - An estimate of item collection size, measured in gigabytes. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.PutRequest"> <summary> <para>Represents a request to perform a <i>PutItem</i> operation on an item.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.PutRequest.WithItem(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Item dictionary. </summary> <param name="pairs">The pairs to be added to the Item dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.PutRequest.Item"> <summary> A map of attribute name to attribute values, representing the primary key of an item to be processed by <i>PutItem</i>. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.QueryRequest"> <summary> Container for the parameters to the Query operation. <para>A <i>Query</i> operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by range key or by index key. </para> <para>Queries that do not return results consume the minimum read capacity units according to the type of read.</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 a <i>LastEvaluatedKey</i> to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns an empty result set <i>and</i> a <i>LastEvaluatedKey</i> . The <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used <i>Limit</i> . </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 <i>ConsistentRead</i> to true 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> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithIndexName(System.String)"> <summary> Sets the IndexName property </summary> <param name="indexName">The value to set for the IndexName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithSelect(System.String)"> <summary> Sets the Select property </summary> <param name="select">The value to set for the Select property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithConsistentRead(System.Boolean)"> <summary> Sets the ConsistentRead property </summary> <param name="consistentRead">The value to set for the ConsistentRead property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithKeyConditions(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.Condition}[])"> <summary> Adds the KeyValuePairs to the KeyConditions dictionary. </summary> <param name="pairs">The pairs to be added to the KeyConditions dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithQueryFilter(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.Condition}[])"> <summary> Adds the KeyValuePairs to the QueryFilter dictionary. </summary> <param name="pairs">The pairs to be added to the QueryFilter dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithConditionalOperator(System.String)"> <summary> Sets the ConditionalOperator property </summary> <param name="conditionalOperator">The value to set for the ConditionalOperator property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithScanIndexForward(System.Boolean)"> <summary> Sets the ScanIndexForward property </summary> <param name="scanIndexForward">The value to set for the ScanIndexForward property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithExclusiveStartKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the ExclusiveStartKey dictionary. </summary> <param name="pairs">The pairs to be added to the ExclusiveStartKey dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.TableName"> <summary> The name of the table containing the requested items. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.IndexName"> <summary> The name of an index to query. This can be any local secondary index or global secondary index on the table. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.Select"> <summary> The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. <ul> <li> <c>ALL_ATTRIBUTES</c>: Returns all of the item attributes from the specified table or index. If you are querying a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.. </li> <li> <c>ALL_PROJECTED_ATTRIBUTES</c>: Allowed only when querying an index. Retrieves all attributes which have been projected into the index. If the index is configured to project all attributes, this is equivalent to specifying <c>ALL_ATTRIBUTES</c>. </li> <li> <c>COUNT</c>: Returns the number of matching items, rather than the matching items themselves. </li> <li> <c>SPECIFIC_ATTRIBUTES</c> : Returns only the attributes listed in <i>AttributesToGet</i>. This is equivalent to specifying <i>AttributesToGet</i> without specifying any value for <i>Select</i>. If you are querying a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you are querying a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. </li> </ul> If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to <c>ALL_ATTRIBUTES</c> when accessing a table, and <c>ALL_PROJECTED_ATTRIBUTES</c> when accessing an index. You cannot use both <i>Select</i> and <i>AttributesToGet</i> together in a single request, <i>unless</i> the value for <i>Select</i> is <c>SPECIFIC_ATTRIBUTES</c>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.) <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.AttributesToGet"> <summary> The names of one or more attributes to retrieve. 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. 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. You cannot use both <i>AttributesToGet</i> and <i>Select</i> together in a <i>Query</i> request, <i>unless</i> the value for <i>Select</i> is <c>SPECIFIC_ATTRIBUTES</c>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.) If you are querying a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you are querying a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.Limit"> <summary> The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to continue the operation. For more information see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan</a> in the Amazon DynamoDB Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ConsistentRead"> <summary> If set to <c>true</c>, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used. Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with <i>ConsistentRead</i> set to <c>true</c>, you will receive an error message. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.KeyConditions"> <summary> The selection criteria for the query. For a query on a table, you can only have conditions on the table primary key attributes. You must specify the hash key attribute name and value as an <c>EQ</c> condition. You can optionally specify a second condition, referring to the range key attribute. For a query on an index, you can only have conditions on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute. If you specify more than one condition in the <i>KeyConditions</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>KeyConditions</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 <i>ComparisonOperator</i> being used. 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, <c>a</c> is greater than <c>A</c>, and <c>aa</c> is greater than <c>B</c>. 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 example when evaluating query expressions. 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 Amazon DynamoDB Developer Guide.</li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. <important>For <i>KeyConditions</i>, the following comparison operators are supported: <c>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</c> </important> For complete descriptions of comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">API_Condition.html</a>. </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.QueryFilter"> <summary> Evaluates the query results and returns only the desired values. If you specify more than one condition in the <i>QueryFilter</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>QueryFilter</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 <i>ComparisonOperator</i> being used. 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, <c>a</c> is greater than <c>A</c>, and <c>aa</c> is greater than <c>B</c>. 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 example when evaluating query expressions. 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 Amazon DynamoDB Developer Guide. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <c>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</c> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">API_Condition.html</a>. </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ConditionalOperator"> <summary> A logical operator to apply to the conditions in the <i>QueryFilter</i> map: <ul> <li><c>AND</c> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> <li><c>OR</c> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> </ul> If you omit <i>ConditionalOperator</i>, then <c>AND</c> is used as the default. The operation will succeed only if the entire map evaluates to true. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>AND, OR</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ScanIndexForward"> <summary> Specifies ascending (true) or descending (false) traversal of the index. DynamoDB returns results reflecting the requested order determined by the range key. If the data type is Number, the results are returned in numeric order. For String, the results are returned in order of ASCII character code values. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. If <i>ScanIndexForward</i> is not specified, the results are returned in ascending order. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ExclusiveStartKey"> <summary> The primary key of the first item that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedKey</i> in the previous operation. The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.QueryResponse"> <summary> Returns information about the QueryResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResponse.QueryResult"> <summary> Gets and sets the QueryResult property. Represents the output of a Query operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.QueryResult"> <summary> <para>Represents the output of a <i>Query</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryResult.WithItems(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryResult.WithItems(System.Collections.Generic.IEnumerable{System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue}})"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryResult.WithCount(System.Int32)"> <summary> Sets the Count property </summary> <param name="count">The value to set for the Count property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryResult.WithScannedCount(System.Int32)"> <summary> Sets the ScannedCount property </summary> <param name="scannedCount">The value to set for the ScannedCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryResult.WithLastEvaluatedKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the LastEvaluatedKey dictionary. </summary> <param name="pairs">The pairs to be added to the LastEvaluatedKey dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity)"> <summary> Sets the ConsumedCapacity property </summary> <param name="consumedCapacity">The value to set for the ConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.Items"> <summary> An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.Count"> <summary> The number of items in the response. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.ScannedCount"> <summary> The number of items in the complete query, before any filters are applied. A high <i>ScannedCount</i> value with few, or no, <i>Count</i> results indicates an inefficient <i>Query</i> operation. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count">Count and ScannedCount</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.LastEvaluatedKey"> <summary> The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If <i>LastEvaluatedKey</i> is null, then the "last page" of results has been processed and there is no more data to be retrieved. If <i>LastEvaluatedKey</i> is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when <i>LastEvaluatedKey</i> is null. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.ConsumedCapacity"> <summary> Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ResourceInUseException.#ctor(System.String)"> <summary> Constructs a new ResourceInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ResourceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ResourceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.ScanRequest"> <summary> Container for the parameters to the Scan operation. <para>The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in the table. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> .</para> <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 with a <i>LastEvaluatedKey</i> 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>The result set is eventually consistent. </para> <para>By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel <i>Scan</i> by specifying 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 Amazon DynamoDB Developer Guide.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithSelect(System.String)"> <summary> Sets the Select property </summary> <param name="select">The value to set for the Select property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithScanFilter(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.Condition}[])"> <summary> Adds the KeyValuePairs to the ScanFilter dictionary. </summary> <param name="pairs">The pairs to be added to the ScanFilter dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithConditionalOperator(System.String)"> <summary> Sets the ConditionalOperator property </summary> <param name="conditionalOperator">The value to set for the ConditionalOperator property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithExclusiveStartKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the ExclusiveStartKey dictionary. </summary> <param name="pairs">The pairs to be added to the ExclusiveStartKey dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithTotalSegments(System.Int32)"> <summary> Sets the TotalSegments property </summary> <param name="totalSegments">The value to set for the TotalSegments property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.WithSegment(System.Int32)"> <summary> Sets the Segment property </summary> <param name="segment">The value to set for the Segment property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.TableName"> <summary> The name of the table containing the requested items. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.AttributesToGet"> <summary> The names of one or more attributes to retrieve. 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. 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. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.Limit"> <summary> The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a <i>LastEvaluatedKey</i> to apply in a subsequent operation to continue the operation. For more information see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan</a> in the Amazon DynamoDB Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.Select"> <summary> The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items. <ul> <li> <c>ALL_ATTRIBUTES</c>: Returns all of the item attributes. </li> <li> <c>COUNT</c>: Returns the number of matching items, rather than the matching items themselves. </li> <li> <c>SPECIFIC_ATTRIBUTES</c> : Returns only the attributes listed in <i>AttributesToGet</i>. This is equivalent to specifying <i>AttributesToGet</i> without specifying any value for <i>Select</i>. </li> </ul> If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to <c>ALL_ATTRIBUTES</c>. You cannot use both <i>Select</i> and <i>AttributesToGet</i> together in a single request, <i>unless</i> the value for <i>Select</i> is <c>SPECIFIC_ATTRIBUTES</c>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.) <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ScanFilter"> <summary> Evaluates the scan results and returns only the desired values. 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 <i>ComparisonOperator</i> being used. 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, <c>a</c> is greater than <c>A</c>, and <c>aa</c> is greater than <c>B</c>. 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 example when evaluating query expressions. 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 Amazon DynamoDB Developer Guide. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <c>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</c> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">API_Condition.html</a>. </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ConditionalOperator"> <summary> A logical operator to apply to the conditions in the <i>ScanFilter</i> map: <ul> <li><c>AND</c> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> <li><c>OR</c> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> </ul> If you omit <i>ConditionalOperator</i>, then <c>AND</c> is used as the default. The operation will succeed only if the entire map evaluates to true. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>AND, OR</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ExclusiveStartKey"> <summary> The primary key of the first item that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedKey</i> in the previous operation. The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed. In a parallel scan, a <i>Scan</i> request that includes <i>ExclusiveStartKey</i> must specify the same segment whose previous <i>Scan</i> returned the corresponding value of <i>LastEvaluatedKey</i>. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.TotalSegments"> <summary> For a parallel <i>Scan</i> request, <i>TotalSegments</i> represents the total number of segments into which the <i>Scan</i> operation will be divided. The value of <i>TotalSegments</i> corresponds to the number of application workers that will perform the parallel scan. 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 - 1000000</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.Segment"> <summary> For a parallel <i>Scan</i> request, <i>Segment</i> identifies an individual segment to be scanned by an application worker. 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. The value of <i>LastEvaluatedKey</i> returned from a parallel <i>Scan</i> request must be used as <i>ExclusiveStartKey</i> with the same Segment ID in a subsequent <i>Scan</i> operation. The value for <i>Segment</i> must be greater 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 - 999999</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ScanResponse"> <summary> Returns information about the ScanResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResponse.ScanResult"> <summary> Gets and sets the ScanResult property. Represents the output of a Scan operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ScanResult"> <summary> <para>Represents the output of a <i>Scan</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanResult.WithItems(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanResult.WithItems(System.Collections.Generic.IEnumerable{System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue}})"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanResult.WithCount(System.Int32)"> <summary> Sets the Count property </summary> <param name="count">The value to set for the Count property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanResult.WithScannedCount(System.Int32)"> <summary> Sets the ScannedCount property </summary> <param name="scannedCount">The value to set for the ScannedCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanResult.WithLastEvaluatedKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the LastEvaluatedKey dictionary. </summary> <param name="pairs">The pairs to be added to the LastEvaluatedKey dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity)"> <summary> Sets the ConsumedCapacity property </summary> <param name="consumedCapacity">The value to set for the ConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.Items"> <summary> An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.Count"> <summary> The number of items in the response. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.ScannedCount"> <summary> The number of items in the complete scan, before any filters are applied. A high <i>ScannedCount</i> value with few, or no, <i>Count</i> results indicates an inefficient <i>Scan</i> operation. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count">Count and ScannedCount</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.LastEvaluatedKey"> <summary> The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If <i>LastEvaluatedKey</i> is null, then the "last page" of results has been processed and there is no more data to be retrieved. If <i>LastEvaluatedKey</i> is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when <i>LastEvaluatedKey</i> is null. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.ConsumedCapacity"> <summary> Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.TableDescription"> <summary> <para>Represents the properties of a table.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithAttributeDefinitions(Amazon.DynamoDBv2.Model.AttributeDefinition[])"> <summary> Adds elements to the AttributeDefinitions collection </summary> <param name="attributeDefinitions">The values to add to the AttributeDefinitions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithAttributeDefinitions(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.AttributeDefinition})"> <summary> Adds elements to the AttributeDefinitions collection </summary> <param name="attributeDefinitions">The values to add to the AttributeDefinitions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithKeySchema(Amazon.DynamoDBv2.Model.KeySchemaElement[])"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithKeySchema(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.KeySchemaElement})"> <summary> Adds elements to the KeySchema collection </summary> <param name="keySchema">The values to add to the KeySchema collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithTableStatus(System.String)"> <summary> Sets the TableStatus property </summary> <param name="tableStatus">The value to set for the TableStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithProvisionedThroughput(Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithTableSizeBytes(System.Int64)"> <summary> Sets the TableSizeBytes property </summary> <param name="tableSizeBytes">The value to set for the TableSizeBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithItemCount(System.Int64)"> <summary> Sets the ItemCount property </summary> <param name="itemCount">The value to set for the ItemCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithLocalSecondaryIndexes(Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription[])"> <summary> Adds elements to the LocalSecondaryIndexes collection </summary> <param name="localSecondaryIndexes">The values to add to the LocalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithLocalSecondaryIndexes(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription})"> <summary> Adds elements to the LocalSecondaryIndexes collection </summary> <param name="localSecondaryIndexes">The values to add to the LocalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithGlobalSecondaryIndexes(Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription[])"> <summary> Adds elements to the GlobalSecondaryIndexes collection </summary> <param name="globalSecondaryIndexes">The values to add to the GlobalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.WithGlobalSecondaryIndexes(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription})"> <summary> Adds elements to the GlobalSecondaryIndexes collection </summary> <param name="globalSecondaryIndexes">The values to add to the GlobalSecondaryIndexes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.AttributeDefinitions"> <summary> An array of <i>AttributeDefinition</i> objects. Each of these objects describes one attribute in the table and index key schema. Each <i>AttributeDefinition</i> object in this array is composed of: <ul> <li> <i>AttributeName</i> - The name of the attribute. </li> <li> <i>AttributeType</i> - The data type for the attribute. </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.TableName"> <summary> The name of the table. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.KeySchema"> <summary> The primary key structure for the table. Each <i>KeySchemaElement</i> consists of: <ul> <li> <i>AttributeName</i> - The name of the attribute. </li> <li> <i>KeyType</i> - The key type for the attribute. Can be either <c>HASH</c> or <c>RANGE</c>. </li> </ul> 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 Amazon DynamoDB Developer Guide. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 2</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.TableStatus"> <summary> The current state of the table: <ul> <li> <i>CREATING</i> - The table is being created, as the result of a <i>CreateTable</i> operation. </li> <li> <i>UPDATING</i> - The table is being updated, as the result of an <i>UpdateTable</i> operation. </li> <li> <i>DELETING</i> - The table is being deleted, as the result of a <i>DeleteTable</i> operation. </li> <li> <i>ACTIVE</i> - The table is ready for use. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CREATING, UPDATING, DELETING, ACTIVE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.CreationDateTime"> <summary> The date and time when the table was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.ProvisionedThroughput"> <summary> The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.TableSizeBytes"> <summary> The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.ItemCount"> <summary> The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.LocalSecondaryIndexes"> <summary> Represents one or more local secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: <ul> <li> <i>IndexName</i> - The name of the local secondary index. </li> <li> <i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table. </li> <li> <i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: <ul> <li> <i>ProjectionType</i> - One of the following: <ul> <li> <c>KEYS_ONLY</c> - Only the index and primary keys are projected into the index. </li> <li> <c>INCLUDE</c> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </li> <li> <c>ALL</c> - All of the table attributes are projected into the index. </li> </ul> </li> <li> <i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. </li> </ul> </li> <li> <i>IndexSizeBytes</i> - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</li> <li> <i>ItemCount</i> - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </li> </ul> If the table is in the <c>DELETING</c> state, no information about indexes will be returned. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.GlobalSecondaryIndexes"> <summary> The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of: <ul> <li> <i>IndexName</i> - The name of the global secondary index. </li> <li> <i>IndexSizeBytes</i> - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </li> <li> <i>IndexStatus</i> - The current status of the global secondary index: <ul> <li> <i>CREATING</i> - The index is being created. </li> <li> <i>UPDATING</i> - The index is being updated. </li> <li> <i>DELETING</i> - The index is being deleted. </li> <li> <i>ACTIVE</i> - The index is ready for use. </li> </ul> </li> <li> <i>ItemCount</i> - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. </li> <li> <i>KeySchema</i> - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table. </li> <li> <i>Projection</i> - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: <ul> <li> <i>ProjectionType</i> - One of the following: <ul> <li> <c>KEYS_ONLY</c> - Only the index and primary keys are projected into the index. </li> <li> <c>INCLUDE</c> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </li> <li> <c>ALL</c> - All of the table attributes are projected into the index. </li> </ul> </li> <li> <i>NonKeyAttributes</i> - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in <i>NonKeyAttributes</i>, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. </li> </ul> </li> <li> <i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. </li> </ul> If the table is in the <c>DELETING</c> state, no information about indexes will be returned. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction"> <summary> <para>Represents the new provisioned throughput settings to be applied to a global secondary index.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction.WithIndexName(System.String)"> <summary> Sets the IndexName property </summary> <param name="indexName">The value to set for the IndexName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction.WithProvisionedThroughput(Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction.IndexName"> <summary> The name of the global secondary index to be updated. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction.ProvisionedThroughput"> <summary> Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the <i>UpdateTable</i> operation. For current minimum and maximum provisioned throughput values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateItemRequest"> <summary> Container for the parameters to the UpdateItem operation. <para> Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (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> <para>In addition to updating an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithKey(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Key dictionary. </summary> <param name="pairs">The pairs to be added to the Key dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithAttributeUpdates(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate}[])"> <summary> Adds the KeyValuePairs to the AttributeUpdates dictionary. </summary> <param name="pairs">The pairs to be added to the AttributeUpdates dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithExpected(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.ExpectedAttributeValue}[])"> <summary> Adds the KeyValuePairs to the Expected dictionary. </summary> <param name="pairs">The pairs to be added to the Expected dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithConditionalOperator(System.String)"> <summary> Sets the ConditionalOperator property </summary> <param name="conditionalOperator">The value to set for the ConditionalOperator property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithReturnValues(System.String)"> <summary> Sets the ReturnValues property </summary> <param name="returnValues">The value to set for the ReturnValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithReturnConsumedCapacity(System.String)"> <summary> Sets the ReturnConsumedCapacity property </summary> <param name="returnConsumedCapacity">The value to set for the ReturnConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.WithReturnItemCollectionMetrics(System.String)"> <summary> Sets the ReturnItemCollectionMetrics property </summary> <param name="returnItemCollectionMetrics">The value to set for the ReturnItemCollectionMetrics property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.TableName"> <summary> The name of the table containing the item to update. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.Key"> <summary> The primary key that defines the item. Each element consists of an attribute name and a value for that attribute. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.AttributeUpdates"> <summary> 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>. 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> - Specifies how to perform the update. Valid values for <i>Action</i> are <c>PUT</c>, <c>DELETE</c>, and <c>ADD</c>. The behavior depends on whether the specified primary key already exists in the table. <b>If an item with the specified <i>Key</i> is found in the table:</b> <ul> <li> <c>PUT</c> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <c>DELETE</c> - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a <i>set</i> of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <c>[a,b,c]</c> and the <i>DELETE</i> action specified <c>[a,c]</c>, then the final attribute value would be <c>[b]</c>. Specifying an empty set is an error. </li> <li> <c>ADD</c> - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of <c>ADD</c> 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 the <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 <c>ADD</c> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. In addition, if you use <c>ADD</c> to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses <c>0</c> as the initial value. For example, suppose that the item you want to update does not yet have an attribute named <i>itemcount</i>, but you decide to <c>ADD</c> the number <c>3</c> to this attribute anyway, even though it currently does not exist. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <c>0</c>, and finally add <c>3</c> to it. The result will be a new <i>itemcount</i> attribute in the item, with a value of <c>3</c>. </note> </li> <li> If the existing data type is a set, and if the <i>Value</i> is also a set, then the <i>Value</i> is added to the existing set. (This is a <i>set</i> operation, not mathematical addition.) For example, if the attribute value was the set <c>[1,2]</c>, and the <c>ADD</c> action specified <c>[3]</c>, then the final attribute value would be <c>[1,2,3]</c>. An error occurs if an Add 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, the <i>Value</i> must also be a set of strings. The same holds true for number sets and binary sets. </li> </ul> This action is only valid for an existing attribute whose data type is number or is a set. Do not use <c>ADD</c> for any other data types. </li> </ul> <b>If no item with the specified <i>Key</i> is found:</b> <ul> <li> <c>PUT</c> - DynamoDB creates a new item with the specified primary key, and then adds the attribute. </li> <li> <c>DELETE</c> - Nothing happens; there is no attribute to delete. </li> <li> <c>ADD</c> - DynamoDB creates 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; no other data types can be specified. </li> </ul> </li> </ul> 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. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.Expected"> <summary> A map of attribute/condition pairs. This is the conditional block for the <i>UpdateItem</i> operation. All the conditions must evaluate to true for the operation to succeed. <i>Expected</i> allows you to provide an attribute name, and whether or not DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it. Each item in <i>Expected</i> represents an attribute name for DynamoDB to check, along with the following: <ul> <li> <i>Value</i> - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used. </li> <li> <i>Exists</i> - Causes DynamoDB to evaluate the value before attempting a conditional operation: <ul> <li> If <i>Exists</i> is <c>true</c>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> <li> If <i>Exists</i> is <c>false</c>, DynamoDB assumes that the attribute value does <i>not</i> exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a <i>ConditionalCheckFailedException</i>. </li> </ul> The default setting for <i>Exists</i> is <c>true</c>. If you supply a <i>Value</i> all by itself, DynamoDB assumes the attribute exists: You don't have to set <i>Exists</i> to <c>true</c>, because it is implied. DynamoDB returns a <i>ValidationException</i> if: <ul> <li> <i>Exists</i> is <c>true</c> but there is no <i>Value</i> to check. (You expect a value to exist, but don't specify what that value is.) </li> <li> <i>Exists</i> is <c>false</c> but you also specify a <i>Value</i>. (You cannot expect an attribute to have a value, while also expecting it not to exist.) </li> </ul> </li> </ul> If you specify more than one condition in the <i>Expected</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.) If <i>Expected</i> evaluates to true, then the conditional operation succeeds; otherwise, it fails. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ConditionalOperator"> <summary> A logical operator to apply to the conditions in the <i>Expected</i> map: <ul> <li><c>AND</c> - If <i>all</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> <li><c>OR</c> - If <i>at least one</i> of the conditions evaluate to true, then the entire map evaluates to true.</li> </ul> If you omit <i>ConditionalOperator</i>, then <c>AND</c> is used as the default. The operation will succeed only if the entire map evaluates to true. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>AND, OR</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ReturnValues"> <summary> 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> <c>NONE</c> - If <i>ReturnValues</i> is not specified, or if its value is <c>NONE</c>, then nothing is returned. (This is the default for <i>ReturnValues</i>.) </li> <li> <c>ALL_OLD</c> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> <li> <c>UPDATED_OLD</c> - The old versions of only the updated attributes are returned. </li> <li> <c>ALL_NEW</c> - All of the attributes of the new version of the item are returned. </li> <li> <c>UPDATED_NEW</c> - The new versions of only the updated attributes are returned. </li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ReturnConsumedCapacity"> <summary> If set to <c>TOTAL</c>, the response includes <i>ConsumedCapacity</i> data for tables and indexes. If set to <c>INDEXES</c>, the response includes <i>ConsumedCapacity</i> for indexes. If set to <c>NONE</c> (the default), <i>ConsumedCapacity</i> is not included in the response. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>INDEXES, TOTAL, NONE</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ReturnItemCollectionMetrics"> <summary> If set to <c>SIZE</c>, statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <c>NONE</c> (the default), no statistics are returned. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>SIZE, NONE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateItemResponse"> <summary> Returns information about the UpdateItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResponse.UpdateItemResult"> <summary> Gets and sets the UpdateItemResult property. Represents the output of an UpdateItem operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateItemResult"> <summary> <para>Represents the output of an <i>UpdateItem</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemResult.WithAttributes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDBv2.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Attributes dictionary. </summary> <param name="pairs">The pairs to be added to the Attributes dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemResult.WithConsumedCapacity(Amazon.DynamoDBv2.Model.ConsumedCapacity)"> <summary> Sets the ConsumedCapacity property </summary> <param name="consumedCapacity">The value to set for the ConsumedCapacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemResult.WithItemCollectionMetrics(Amazon.DynamoDBv2.Model.ItemCollectionMetrics)"> <summary> Sets the ItemCollectionMetrics property </summary> <param name="itemCollectionMetrics">The value to set for the ItemCollectionMetrics property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResult.Attributes"> <summary> A map of attribute values as they appeared before the <i>UpdateItem</i> operation, but only if <i>ReturnValues</i> was specified as something other than <c>NONE</c> in the request. Each element represents one attribute. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResult.ConsumedCapacity"> <summary> Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. <i>ConsumedCapacity</i> is only returned if it was asked for in the request. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResult.ItemCollectionMetrics"> <summary> Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if it was asked for in the request. If the table does not have any local secondary indexes, this information is not returned in the response. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateTableRequest"> <summary> Container for the parameters to the UpdateTable operation. <para>Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of DynamoDB.</para> <para>The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> section in the Amazon DynamoDB Developer Guide.</para> <para>The table must be in the <c>ACTIVE</c> state for this operation to succeed. <i>UpdateTable</i> is an asynchronous operation; while executing the operation, the table is in the <c>UPDATING</c> state. While the table is in the <c>UPDATING</c> state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the <c>ACTIVE</c> state after the <i>UpdateTable</i> operation. </para> <para>You cannot add, modify or delete indexes using <i>UpdateTable</i> . Indexes can only be defined at table creation time.</para> </summary> <seealso cref="M:Amazon.DynamoDBv2.AmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"/> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateTableRequest.WithProvisionedThroughput(Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateTableRequest.WithGlobalSecondaryIndexUpdates(Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate[])"> <summary> Adds elements to the GlobalSecondaryIndexUpdates collection </summary> <param name="globalSecondaryIndexUpdates">The values to add to the GlobalSecondaryIndexUpdates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateTableRequest.WithGlobalSecondaryIndexUpdates(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate})"> <summary> Adds elements to the GlobalSecondaryIndexUpdates collection </summary> <param name="globalSecondaryIndexUpdates">The values to add to the GlobalSecondaryIndexUpdates collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.TableName"> <summary> The name of the table to be updated. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.ProvisionedThroughput"> <summary> Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the <i>UpdateTable</i> operation. For current minimum and maximum provisioned throughput values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> in the Amazon DynamoDB Developer Guide. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.GlobalSecondaryIndexUpdates"> <summary> An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateTableResponse"> <summary> Returns information about the UpdateTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableResponse.UpdateTableResult"> <summary> Gets and sets the UpdateTableResult property. Represents the output of an UpdateTable operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateTableResult"> <summary> <para>Represents the output of an <i>UpdateTable</i> operation.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateTableResult.WithTableDescription(Amazon.DynamoDBv2.Model.TableDescription)"> <summary> Sets the TableDescription property </summary> <param name="tableDescription">The value to set for the TableDescription property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableResult.TableDescription"> <summary> Represents the properties of a table. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.WriteRequest"> <summary> <para>Represents an operation to perform - either <i>DeleteItem</i> or <i>PutItem</i> . You can only specify one of these operations, not both, in a single <i>WriteRequest</i> . If you do need to perform both of these operations, you will need to specify two separate <i>WriteRequest</i> objects.</para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.WriteRequest.WithPutRequest(Amazon.DynamoDBv2.Model.PutRequest)"> <summary> Sets the PutRequest property </summary> <param name="putRequest">The value to set for the PutRequest property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDBv2.Model.WriteRequest.WithDeleteRequest(Amazon.DynamoDBv2.Model.DeleteRequest)"> <summary> Sets the DeleteRequest property </summary> <param name="deleteRequest">The value to set for the DeleteRequest property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDBv2.Model.WriteRequest.PutRequest"> <summary> A request to perform a <i>PutItem</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.WriteRequest.DeleteRequest"> <summary> A request to perform a <i>DeleteItem</i> operation. </summary> </member> <member name="T:Amazon.DynamoDB.AmazonDynamoDB"> <summary> Interface for accessing AmazonDynamoDB. <para>Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service.</para> <para>Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and predictable performance.</para> </summary> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.Scan(Amazon.DynamoDB.Model.ScanRequest)"> <summary> <para>Retrieves one or more items and its attributes by performing a full scan of a table.</para> <para>Provide a <c>ScanFilter</c> to get more specific results.</para> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan service method on AmazonDynamoDB.</param> <returns>The response from the Scan service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginScan(Amazon.DynamoDB.Model.ScanRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Scan(Amazon.DynamoDB.Model.ScanRequest)"/> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndScan operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndScan(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Scan(Amazon.DynamoDB.Model.ScanRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScan.</param> <returns>Returns a ScanResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.CreateTable(Amazon.DynamoDB.Model.CreateTableRequest)"> <summary> <para>Adds a new table to your account.</para> <para>The table name must be unique among those associated with the AWS Account issuing the request, and the AWS Region that receives the request (e.g. <c>us-east-1</c> ).</para> <para>The <c>CreateTable</c> operation triggers an asynchronous workflow to begin creating the table. Amazon DynamoDB immediately returns the state of the table ( <c>CREATING</c> ) until the table is in the <c>ACTIVE</c> state. Once the table is in the <c>ACTIVE</c> state, you can perform data plane operations.</para> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable service method on AmazonDynamoDB.</param> <returns>The response from the CreateTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDB.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginCreateTable(Amazon.DynamoDB.Model.CreateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.CreateTable(Amazon.DynamoDB.Model.CreateTableRequest)"/> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndCreateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.CreateTable(Amazon.DynamoDB.Model.CreateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTable.</param> <returns>Returns a CreateTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.ListTables(Amazon.DynamoDB.Model.ListTablesRequest)"> <summary> <para>Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. <c>us-east-1</c> ).</para> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables service method on AmazonDynamoDB.</param> <returns>The response from the ListTables service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginListTables(Amazon.DynamoDB.Model.ListTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.ListTables(Amazon.DynamoDB.Model.ListTablesRequest)"/> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTables operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndListTables(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.ListTables(Amazon.DynamoDB.Model.ListTablesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTables.</param> <returns>Returns a ListTablesResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.ListTables"> <summary> <para>Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. <c>us-east-1</c> ).</para> </summary> <returns>The response from the ListTables service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.Query(Amazon.DynamoDB.Model.QueryRequest)"> <summary> <para>Gets the values of one or more items and its attributes by primary key (composite primary key, only).</para> <para>Narrow the scope of the query using comparison operators on the <c>RangeKeyValue</c> of the composite key. Use the <c>ScanIndexForward</c> parameter to get results in forward or reverse order by range key.</para> </summary> <param name="queryRequest">Container for the necessary parameters to execute the Query service method on AmazonDynamoDB.</param> <returns>The response from the Query service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginQuery(Amazon.DynamoDB.Model.QueryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Query(Amazon.DynamoDB.Model.QueryRequest)"/> </summary> <param name="queryRequest">Container for the necessary parameters to execute the Query operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndQuery operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndQuery(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Query(Amazon.DynamoDB.Model.QueryRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQuery.</param> <returns>Returns a QueryResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest)"> <summary> <para>Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.</para> <para>There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.</para> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem service method on AmazonDynamoDB.</param> <returns>The response from the BatchWriteItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginBatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest)"/> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchWriteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndBatchWriteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchWriteItem.</param> <returns>Returns a BatchWriteItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest)"> <summary> <para>Edits an existing item's attributes.</para> <para>You can perform a conditional update (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> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem service method on AmazonDynamoDB.</param> <returns>The response from the UpdateItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginUpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest)"/> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndUpdateItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Returns a UpdateItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest)"> <summary> <para>Updates the provisioned throughput for the given table.</para> <para>Setting the throughput for a table helps you manage performance and is part of the Provisioned Throughput feature of Amazon DynamoDB.</para> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable service method on AmazonDynamoDB.</param> <returns>The response from the UpdateTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDB.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginUpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest)"/> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndUpdateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTable.</param> <returns>Returns a UpdateTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.PutItem(Amazon.DynamoDB.Model.PutItemRequest)"> <summary> <para>Creates a new item, or replaces an old item with a new item (including all the attributes).</para> <para>If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert 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> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem service method on AmazonDynamoDB.</param> <returns>The response from the PutItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginPutItem(Amazon.DynamoDB.Model.PutItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.PutItem(Amazon.DynamoDB.Model.PutItemRequest)"/> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndPutItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.PutItem(Amazon.DynamoDB.Model.PutItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Returns a PutItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest)"> <summary> <para>Deletes a table and all of its items.</para> <para>If the table is in the <c>ACTIVE</c> state, you can delete it. If a table is in <c>CREATING</c> or <c>UPDATING</c> states then Amazon DynamoDB returns a <c>ResourceInUseException</c> . If the specified table does not exist, Amazon DynamoDB returns a <c>ResourceNotFoundException</c> .</para> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable service method on AmazonDynamoDB.</param> <returns>The response from the DeleteTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDB.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginDeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest)"/> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndDeleteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTable.</param> <returns>Returns a DeleteTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest)"> <summary> <para>Deletes a single item in a table by primary key.</para> <para>You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.</para> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem service method on AmazonDynamoDB.</param> <returns>The response from the DeleteItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginDeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest)"/> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndDeleteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Returns a DeleteItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.DescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest)"> <summary> <para>Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.</para> <para>If the table does not exist, Amazon DynamoDB returns a <c>ResourceNotFoundException</c> .</para> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable service method on AmazonDynamoDB.</param> <returns>The response from the DescribeTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginDescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest)"/> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndDescribeTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTable.</param> <returns>Returns a DescribeTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.GetItem(Amazon.DynamoDB.Model.GetItemRequest)"> <summary> <para>Retrieves a set of Attributes for an item that matches the primary key.</para> <para>The <c>GetItem</c> operation provides an eventually-consistent read by default. If eventually-consistent reads are not acceptable for your application, use <c>ConsistentRead</c> . Although this operation might take longer than a standard read, it always returns the last updated value.</para> </summary> <param name="getItemRequest">Container for the necessary parameters to execute the GetItem service method on AmazonDynamoDB.</param> <returns>The response from the GetItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginGetItem(Amazon.DynamoDB.Model.GetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.GetItem(Amazon.DynamoDB.Model.GetItemRequest)"/> </summary> <param name="getItemRequest">Container for the necessary parameters to execute the GetItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.GetItem(Amazon.DynamoDB.Model.GetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Returns a GetItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest)"> <summary> <para>Retrieves the attributes for multiple items from multiple tables using their primary keys.</para> <para>The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial result is returned due to an internal processing failure, Amazon DynamoDB returns an <c>UnprocessedKeys</c> value so you can retry the operation starting with the next item to get.</para> <para>Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50k in size, the system returns 20 items and an appropriate <c>UnprocessedKeys</c> value so you can get the next page of results. If necessary, your application needs its own logic to assemble the pages of results into one set.</para> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem service method on AmazonDynamoDB.</param> <returns>The response from the BatchGetItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.BeginBatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest)"/> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDB.EndBatchGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetItem.</param> <returns>Returns a BatchGetItemResult from AmazonDynamoDB.</returns> </member> <member name="T:Amazon.DynamoDB.AmazonDynamoDBClient"> <summary> Implementation for accessing AmazonDynamoDB. <para>Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service.</para> <para>Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and predictable performance.</para> </summary> </member> <member name="M:Amazon.DynamoDB.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DynamoDB.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.#ctor(Amazon.DynamoDB.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDynamoDB Configuration Object</param> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDynamoDBClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.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.DynamoDB.AmazonDynamoDBClient.#ctor(System.String,System.String,Amazon.DynamoDB.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.DynamoDB.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.DynamoDB.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.DynamoDB.AmazonDynamoDBClient.#ctor(System.String,System.String,System.String,Amazon.DynamoDB.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.DynamoDB.AmazonDynamoDBClient.Scan(Amazon.DynamoDB.Model.ScanRequest)"> <summary> <para>Retrieves one or more items and its attributes by performing a full scan of a table.</para> <para>Provide a <c>ScanFilter</c> to get more specific results.</para> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan service method on AmazonDynamoDB.</param> <returns>The response from the Scan service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginScan(Amazon.DynamoDB.Model.ScanRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Scan(Amazon.DynamoDB.Model.ScanRequest)"/> </summary> <param name="scanRequest">Container for the necessary parameters to execute the Scan operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndScan operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndScan(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Scan operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Scan(Amazon.DynamoDB.Model.ScanRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScan.</param> <returns>Returns a ScanResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.CreateTable(Amazon.DynamoDB.Model.CreateTableRequest)"> <summary> <para>Adds a new table to your account.</para> <para>The table name must be unique among those associated with the AWS Account issuing the request, and the AWS Region that receives the request (e.g. <c>us-east-1</c> ).</para> <para>The <c>CreateTable</c> operation triggers an asynchronous workflow to begin creating the table. Amazon DynamoDB immediately returns the state of the table ( <c>CREATING</c> ) until the table is in the <c>ACTIVE</c> state. Once the table is in the <c>ACTIVE</c> state, you can perform data plane operations.</para> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable service method on AmazonDynamoDB.</param> <returns>The response from the CreateTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDB.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginCreateTable(Amazon.DynamoDB.Model.CreateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.CreateTable(Amazon.DynamoDB.Model.CreateTableRequest)"/> </summary> <param name="createTableRequest">Container for the necessary parameters to execute the CreateTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndCreateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.CreateTable(Amazon.DynamoDB.Model.CreateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTable.</param> <returns>Returns a CreateTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.ListTables(Amazon.DynamoDB.Model.ListTablesRequest)"> <summary> <para>Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. <c>us-east-1</c> ).</para> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables service method on AmazonDynamoDB.</param> <returns>The response from the ListTables service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginListTables(Amazon.DynamoDB.Model.ListTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.ListTables(Amazon.DynamoDB.Model.ListTablesRequest)"/> </summary> <param name="listTablesRequest">Container for the necessary parameters to execute the ListTables operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTables operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndListTables(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTables operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.ListTables(Amazon.DynamoDB.Model.ListTablesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTables.</param> <returns>Returns a ListTablesResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.ListTables"> <summary> <para>Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. <c>us-east-1</c> ).</para> </summary> <returns>The response from the ListTables service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.Query(Amazon.DynamoDB.Model.QueryRequest)"> <summary> <para>Gets the values of one or more items and its attributes by primary key (composite primary key, only).</para> <para>Narrow the scope of the query using comparison operators on the <c>RangeKeyValue</c> of the composite key. Use the <c>ScanIndexForward</c> parameter to get results in forward or reverse order by range key.</para> </summary> <param name="queryRequest">Container for the necessary parameters to execute the Query service method on AmazonDynamoDB.</param> <returns>The response from the Query service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginQuery(Amazon.DynamoDB.Model.QueryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Query(Amazon.DynamoDB.Model.QueryRequest)"/> </summary> <param name="queryRequest">Container for the necessary parameters to execute the Query operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndQuery operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndQuery(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Query operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Query(Amazon.DynamoDB.Model.QueryRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQuery.</param> <returns>Returns a QueryResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest)"> <summary> <para>Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.</para> <para>There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.</para> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem service method on AmazonDynamoDB.</param> <returns>The response from the BatchWriteItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginBatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest)"/> </summary> <param name="batchWriteItemRequest">Container for the necessary parameters to execute the BatchWriteItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchWriteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndBatchWriteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchWriteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchWriteItem.</param> <returns>Returns a BatchWriteItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.UpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest)"> <summary> <para>Edits an existing item's attributes.</para> <para>You can perform a conditional update (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> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem service method on AmazonDynamoDB.</param> <returns>The response from the UpdateItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginUpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest)"/> </summary> <param name="updateItemRequest">Container for the necessary parameters to execute the UpdateItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndUpdateItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Returns a UpdateItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.UpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest)"> <summary> <para>Updates the provisioned throughput for the given table.</para> <para>Setting the throughput for a table helps you manage performance and is part of the Provisioned Throughput feature of Amazon DynamoDB.</para> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable service method on AmazonDynamoDB.</param> <returns>The response from the UpdateTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDB.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginUpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest)"/> </summary> <param name="updateTableRequest">Container for the necessary parameters to execute the UpdateTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndUpdateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTable.</param> <returns>Returns a UpdateTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.PutItem(Amazon.DynamoDB.Model.PutItemRequest)"> <summary> <para>Creates a new item, or replaces an old item with a new item (including all the attributes).</para> <para>If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert 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> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem service method on AmazonDynamoDB.</param> <returns>The response from the PutItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginPutItem(Amazon.DynamoDB.Model.PutItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.PutItem(Amazon.DynamoDB.Model.PutItemRequest)"/> </summary> <param name="putItemRequest">Container for the necessary parameters to execute the PutItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndPutItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.PutItem(Amazon.DynamoDB.Model.PutItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Returns a PutItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.DeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest)"> <summary> <para>Deletes a table and all of its items.</para> <para>If the table is in the <c>ACTIVE</c> state, you can delete it. If a table is in <c>CREATING</c> or <c>UPDATING</c> states then Amazon DynamoDB returns a <c>ResourceInUseException</c> . If the specified table does not exist, Amazon DynamoDB returns a <c>ResourceNotFoundException</c> .</para> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable service method on AmazonDynamoDB.</param> <returns>The response from the DeleteTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ResourceInUseException"/> <exception cref="T:Amazon.DynamoDB.Model.LimitExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginDeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest)"/> </summary> <param name="deleteTableRequest">Container for the necessary parameters to execute the DeleteTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndDeleteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTable.</param> <returns>Returns a DeleteTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.DeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest)"> <summary> <para>Deletes a single item in a table by primary key.</para> <para>You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.</para> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem service method on AmazonDynamoDB.</param> <returns>The response from the DeleteItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.ConditionalCheckFailedException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginDeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest)"/> </summary> <param name="deleteItemRequest">Container for the necessary parameters to execute the DeleteItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndDeleteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Returns a DeleteItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.DescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest)"> <summary> <para>Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.</para> <para>If the table does not exist, Amazon DynamoDB returns a <c>ResourceNotFoundException</c> .</para> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable service method on AmazonDynamoDB.</param> <returns>The response from the DescribeTable service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginDescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest)"/> </summary> <param name="describeTableRequest">Container for the necessary parameters to execute the DescribeTable operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTable operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndDescribeTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTable operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTable.</param> <returns>Returns a DescribeTableResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.GetItem(Amazon.DynamoDB.Model.GetItemRequest)"> <summary> <para>Retrieves a set of Attributes for an item that matches the primary key.</para> <para>The <c>GetItem</c> operation provides an eventually-consistent read by default. If eventually-consistent reads are not acceptable for your application, use <c>ConsistentRead</c> . Although this operation might take longer than a standard read, it always returns the last updated value.</para> </summary> <param name="getItemRequest">Container for the necessary parameters to execute the GetItem service method on AmazonDynamoDB.</param> <returns>The response from the GetItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginGetItem(Amazon.DynamoDB.Model.GetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.GetItem(Amazon.DynamoDB.Model.GetItemRequest)"/> </summary> <param name="getItemRequest">Container for the necessary parameters to execute the GetItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.GetItem(Amazon.DynamoDB.Model.GetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Returns a GetItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest)"> <summary> <para>Retrieves the attributes for multiple items from multiple tables using their primary keys.</para> <para>The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial result is returned due to an internal processing failure, Amazon DynamoDB returns an <c>UnprocessedKeys</c> value so you can retry the operation starting with the next item to get.</para> <para>Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50k in size, the system returns 20 items and an appropriate <c>UnprocessedKeys</c> value so you can get the next page of results. If necessary, your application needs its own logic to assemble the pages of results into one set.</para> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem service method on AmazonDynamoDB.</param> <returns>The response from the BatchGetItem service method, as returned by AmazonDynamoDB.</returns> <exception cref="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"/> <exception cref="T:Amazon.DynamoDB.Model.InternalServerErrorException"/> <exception cref="T:Amazon.DynamoDB.Model.ResourceNotFoundException"/> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.BeginBatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest)"/> </summary> <param name="batchGetItemRequest">Container for the necessary parameters to execute the BatchGetItem operation on AmazonDynamoDB.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.EndBatchGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetItem operation. <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetItem.</param> <returns>Returns a BatchGetItemResult from AmazonDynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBClient.pauseExponentially(System.Int32)"> <summary> Override the pausing function so retries would happen more frequent then the default operation. </summary> <param name="retries">Current number of retries.</param> </member> <member name="T:Amazon.DynamoDB.AmazonDynamoDBConfig"> <summary> Configuration for accessing service </summary> </member> <member name="M:Amazon.DynamoDB.AmazonDynamoDBConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.DynamoDB.AmazonDynamoDBConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.DynamoDB.AmazonDynamoDBConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBAttribute"> <summary> Base DynamoDB attribute. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBTableAttribute"> <summary> DynamoDB attribute that marks a class. Specifies that this object can be stored in DynamoDB, the name of the target table, and if attribute names must be automatically converted to lowerCamelCase. Need not be declared on subclasses if present on base class. Can be defined on subclasses to specify different target table or specify different attribute casing. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBIgnoreAttribute"> <summary> DynamoDB attribute that directs the specified attribute not to be included when saving or loading objects. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBRenamableAttribute"> <summary> DynamoDB property attribute. Can be used to specify an alternative attribute name or configure a custom converter. </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBRenamableAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBRenamableAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBRenamableAttribute.AttributeName"> <summary> Name of attribute that is associated with this member. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBVersionAttribute"> <summary> DynamoDB property that marks up current member as item version. At most one member in a class may be marked with this attribute. Members that are marked as version must be of primitive, numeric, integer, nullable type (e.g. int?, long?, byte?) </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBPropertyAttribute"> <summary> DynamoDB property attribute. Can be used to specify an alternative attribute name or configure a custom converter. </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBPropertyAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBPropertyAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBPropertyAttribute.#ctor(System.Type)"> <summary> Constructor that specifies a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="converter">Custom converter type.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBPropertyAttribute.#ctor(System.String,System.Type)"> <summary> Constructor that specifies an alternate attribute name and a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> <param name="converter">Custom converter type.</param> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBPropertyAttribute.Converter"> <summary> Type of the custom converter. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBHashKeyAttribute"> <summary> DynamoDB property that marks up current member as a hash key element. Exactly one member in a class must be marked with this attribute. Members that are marked as hash key must be convertible to a Primitive object. </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBHashKeyAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBHashKeyAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBHashKeyAttribute.#ctor(System.Type)"> <summary> Constructor that specifies a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="converter">Custom converter type.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBHashKeyAttribute.#ctor(System.String,System.Type)"> <summary> Constructor that specifies an alternate attribute name and a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> <param name="converter">Custom converter type.</param> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBRangeKeyAttribute"> <summary> DynamoDB property that marks up current member as range key element (for a hash-and-range primary key). At most one member in a class may be marked with this attribute. Members that are marked as a range key element must be convertible to a Primitive object. </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBRangeKeyAttribute.#ctor"> <summary> Default constructor </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBRangeKeyAttribute.#ctor(System.String)"> <summary> Constructor that specifies an alternate attribute name </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBRangeKeyAttribute.#ctor(System.Type)"> <summary> Constructor that specifies a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="converter">Custom converter type.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBRangeKeyAttribute.#ctor(System.String,System.Type)"> <summary> Constructor that specifies an alternate attribute name and a custom converter. Converter must be the type of a class that implements IPropertyConverter. </summary> <param name="attributeName"> Name of attribute to be associated with property or field. </param> <param name="converter">Custom converter type.</param> </member> <member name="T:Amazon.DynamoDB.DataModel.BatchGet"> <summary> Represents a non-generic object for retrieving a batch of items from a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchGet.AddKey(System.Object)"> <summary> Add a single item to get, identified by its hash primary key. </summary> <param name="hashKey">Hash key of the item to get</param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchGet.AddKey(System.Object,System.Object)"> <summary> Add a single item to get, identified by its hash-and-range primary key. </summary> <param name="hashKey">Hash key of the item to get</param> <param name="rangeKey">Range key of the item to get</param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchGet.Execute"> <summary> Executes a server call to batch-get the items requested. </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchGet.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.BatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.BatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.DataModel.BatchGet.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.BatchGet.ConsistentRead"> <summary> If set to true, a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.BatchGet`1"> <summary> Represents a strongly-typed object for retrieving a batch of items from a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchGet`1.Combine(Amazon.DynamoDB.DataModel.BatchGet[])"> <summary> Creates a MultiTableBatchGet object that is a combination of the current BatchGet and the specified BatchGets </summary> <param name="otherBatches">Other BatchGet objects</param> <returns> MultiTableBatchGet consisting of the multiple BatchGet objects: the current batch and the passed-in batches. </returns> </member> <member name="P:Amazon.DynamoDB.DataModel.BatchGet`1.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.MultiTableBatchGet"> <summary> Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.MultiTableBatchGet.#ctor(Amazon.DynamoDB.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.DynamoDB.DataModel.MultiTableBatchGet.AddBatch(Amazon.DynamoDB.DataModel.BatchGet)"> <summary> Add a BatchGet object to the multi-table batch request </summary> <param name="batch">BatchGet to add</param> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.DataModel.MultiTableBatchGet.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.MultiTableBatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.MultiTableBatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.MultiTableBatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="P:Amazon.DynamoDB.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.DynamoDB.DataModel.BatchWrite"> <summary> Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.DataModel.BatchWrite.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.BatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.BatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite.ExecuteHelper(System.Boolean)"> <summary> Executes a server call to batch-write/delete the items requested. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.BatchWrite`1"> <summary> Represents a strongly-typed object for writing/deleting a batch of items in a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite`1.Combine(Amazon.DynamoDB.DataModel.BatchWrite[])"> <summary> Creates a MultiTableBatchWrite object that is a combination of the current BatchWrite and the specified BatchWrites </summary> <param name="otherBatches">Other BatchWrite objects</param> <returns> MultiTableBatchWrite consisting of the multiple BatchWrite objects: the current batch and the passed-in batches. </returns> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite`1.AddPutItems(System.Collections.Generic.IEnumerable{`0})"> <summary> Add a number of items to be put in the current batch operation </summary> <param name="values">Items to put</param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite`1.AddPutItem(`0)"> <summary> Add a single item to be put in the current batch operation </summary> <param name="item"></param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite`1.AddDeleteItems(System.Collections.Generic.IEnumerable{`0})"> <summary> Add a number of items to be deleted in the current batch operation </summary> <param name="values">Items to be deleted</param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite`1.AddDeleteItem(`0)"> <summary> Add a single item to be deleted in the current batch operation. </summary> <param name="item">Item to be deleted</param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite`1.AddDeleteKey(System.Object)"> <summary> Add a single item to be deleted in the current batch operation. Item is identified by its hash primary key. </summary> <param name="hashKey">Hash key of the item to delete</param> </member> <member name="M:Amazon.DynamoDB.DataModel.BatchWrite`1.AddDeleteKey(System.Object,System.Object)"> <summary> Add a single item to be deleted in the current batch operation. Item is identified by its hash-and-range primary key. </summary> <param name="hashKey">Hash key of the item to delete</param> <param name="rangeKey">Range key of the item to delete</param> </member> <member name="T:Amazon.DynamoDB.DataModel.MultiTableBatchWrite"> <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.DynamoDB.DataModel.MultiTableBatchWrite.#ctor(Amazon.DynamoDB.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.DynamoDB.DataModel.MultiTableBatchWrite.AddBatch(Amazon.DynamoDB.DataModel.BatchWrite)"> <summary> Add a BatchWrite object to the multi-table batch request </summary> <param name="batch">BatchGet to add</param> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.DataModel.MultiTableBatchWrite.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.MultiTableBatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.MultiTableBatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DataModel.MultiTableBatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="T:Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.DataModel.IPropertyConverter.FromEntry(Amazon.DynamoDB.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="T:Amazon.DynamoDB.DataModel.DynamoDBContextConfig"> <summary> Configuration object for setting options on the DynamoDBContext. and individual operations. </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBContextConfig.ConsistentRead"> <summary> Property that directs DynamoDBContext to use consistent reads. If property is not set, behavior defaults to non-consistent reads. </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBContextConfig.SkipVersionCheck"> <summary> Property that directs DynamoDBContext to skip version checks when saving or deleting an object with a version attribute. If property is not set, version checks are performed. </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBContextConfig.TableNamePrefix"> <summary> Property that directs DynamoDBContext to prefix all table names with a specific string. If property is null or empty, no prefix is used and default table names are used. </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBContextConfig.IgnoreNullValues"> <summary> Property that directs DynamoDBContext to ignore null values on attributes during a Save operation. If the property is false (or not set), null values will be interpreted as directives to delete the specific attribute. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBOperationConfig"> <summary> Configuration object for setting options for individual operations. This will override any settings specified by the DynamoDBContext's DynamoDBContextConfig object. </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBOperationConfig.OverrideTableName"> <summary> Property that indicates the table to save an object to overriding the DynamoDBTable attribute declared for the type. </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.DynamoDBOperationConfig.BackwardQuery"> <summary> Property that indicates a query should traverse the index backward. If the property is false (or not set), traversal shall be forward. </summary> </member> <member name="T:Amazon.DynamoDB.DataModel.DynamoDBContext"> <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.DynamoDB.DataModel.IDynamoDBContext"> <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.DynamoDB.DataModel.IDynamoDBContext.Save``1(``0)"> <summary> Saves an object to DynamoDB. Uses DynamoDBContextConfig configured 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> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.Save``1(``0,Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.BeginSave``1(``0,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginSave``1(``0,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.EndSave(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSave.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.Load``1(System.Object)"> <summary> Loads an object from DynamoDB for the given hash primary key. Uses DynamoDBContextConfig configured 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.DynamoDB.DataModel.IDynamoDBContext.Load``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given hash 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.DynamoDB.DataModel.IDynamoDBContext.Load``1(System.Object,System.Object)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key. Uses DynamoDBContextConfig configured 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.DynamoDB.DataModel.IDynamoDBContext.Load``1(System.Object,System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.FromDocument``1(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.BeginLoad``1(System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginLoad``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginLoad``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginLoad``1(System.Object,System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.EndLoad``1(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLoad.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.Delete``1(``0)"> <summary> Deletes an item in DynamoDB corresponding to given object. Uses DynamoDBContextConfig configured 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.DynamoDB.DataModel.IDynamoDBContext.Delete``1(``0,Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.Delete``1(System.Object)"> <summary> Deletes an item in DynamoDB corresponding to a given hash 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.DynamoDB.DataModel.IDynamoDBContext.Delete``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to a given hash 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.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.Delete``1(System.Object,System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.BeginDelete``1(``0,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginDelete``1(``0,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.BeginDelete``1(System.Object,System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.EndDelete(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDelete.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.Scan``1(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.Scan``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDB.DataModel.ScanCondition},Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.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.DynamoDB.DataModel.IDynamoDBContext.Query``1(System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.Query``1(System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.Query``1(System.Object,Amazon.DynamoDB.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.FromScan``1(Amazon.DynamoDB.DocumentModel.ScanOperationConfig)"> <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> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.FromScan``1(Amazon.DynamoDB.DocumentModel.ScanOperationConfig,Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.FromQuery``1(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.FromQuery``1(Amazon.DynamoDB.DocumentModel.QueryOperationConfig,Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.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.DynamoDB.DataModel.IDynamoDBContext.CreateBatchGet``1(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.CreateMultiTableBatchGet(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.ExecuteBatchGet(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.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.DynamoDB.DataModel.IDynamoDBContext.CreateBatchWrite``1(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.CreateMultiTableBatchWrite(Amazon.DynamoDB.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.DynamoDB.DataModel.IDynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDB.DataModel.BatchWrite[])"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> </member> <member name="M:Amazon.DynamoDB.DataModel.IDynamoDBContext.GetTargetTable``1"> <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.DynamoDB.DataModel.IDynamoDBContext.GetTargetTable``1(Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.#ctor(Amazon.RegionEndpoint,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDB.AmazonDynamoDB)"> <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.DynamoDB.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDB.AmazonDynamoDB,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.Save``1(``0)"> <summary> Saves an object to DynamoDB. Uses DynamoDBContextConfig configured 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> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Save``1(``0,Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.BeginSave``1(``0,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginSave``1(``0,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <typeparam name="T">Type to save as.</typeparam> <param name="value">Object to save.</param> <param name="operationConfig">Overriding configuration.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSave operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.EndSave(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Save operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Save``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSave.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Load``1(System.Object)"> <summary> Loads an object from DynamoDB for the given hash primary key. Uses DynamoDBContextConfig configured 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.DynamoDB.DataModel.DynamoDBContext.Load``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig)"> <summary> Loads an object from DynamoDB for the given hash 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.DynamoDB.DataModel.DynamoDBContext.Load``1(System.Object,System.Object)"> <summary> Loads an object from DynamoDB for the given hash-and-range primary key. Uses DynamoDBContextConfig configured 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.DynamoDB.DataModel.DynamoDBContext.Load``1(System.Object,System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.FromDocument``1(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.BeginLoad``1(System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginLoad``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginLoad``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginLoad``1(System.Object,System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLoad operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.EndLoad``1(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Load operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Load``1(System.Object)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLoad.</param> <returns> Object of type T, populated with properties of item loaded from DynamoDB. </returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Delete``1(``0)"> <summary> Deletes an item in DynamoDB corresponding to given object. Uses DynamoDBContextConfig configured 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.DynamoDB.DataModel.DynamoDBContext.Delete``1(``0,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.Delete``1(System.Object)"> <summary> Deletes an item in DynamoDB corresponding to a given hash 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.DynamoDB.DataModel.DynamoDBContext.Delete``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig)"> <summary> Deletes an item in DynamoDB corresponding to a given hash 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.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.Delete``1(System.Object,System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.BeginDelete``1(``0,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <typeparam name="T">Type of object.</typeparam> <param name="value">Object to delete.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginDelete``1(``0,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginDelete``1(System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginDelete``1(System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginDelete``1(System.Object,System.Object,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.BeginDelete``1(System.Object,System.Object,Amazon.DynamoDB.DataModel.DynamoDBOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDelete operation.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.EndDelete(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Delete operation. <seealso cref="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Delete``1(``0)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDelete.</param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.Scan``1(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.Scan``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDB.DataModel.ScanCondition},Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.Query``1(System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.Query``1(System.Object,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.Query``1(System.Object,Amazon.DynamoDB.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.FromScan``1(Amazon.DynamoDB.DocumentModel.ScanOperationConfig)"> <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> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.FromScan``1(Amazon.DynamoDB.DocumentModel.ScanOperationConfig,Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.FromQuery``1(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.FromQuery``1(Amazon.DynamoDB.DocumentModel.QueryOperationConfig,Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.CreateBatchGet``1(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.CreateMultiTableBatchGet(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.ExecuteBatchGet(Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.CreateBatchWrite``1(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.CreateMultiTableBatchWrite(Amazon.DynamoDB.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.DynamoDB.DataModel.DynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDB.DataModel.BatchWrite[])"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> </member> <member name="M:Amazon.DynamoDB.DataModel.DynamoDBContext.GetTargetTable``1"> <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.DynamoDB.DataModel.DynamoDBContext.GetTargetTable``1(Amazon.DynamoDB.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="T:Amazon.DynamoDB.DataModel.ScanCondition"> <summary> Class describing a single scan condition </summary> </member> <member name="M:Amazon.DynamoDB.DataModel.ScanCondition.#ctor(System.String,Amazon.DynamoDB.DocumentModel.ScanOperator,System.Object[])"> <summary> Initializes a ScanCondition with the target property, the comparison operator and values being tested against. </summary> <param name="propertyName">Name of the property</param> <param name="op">Comparison operator</param> <param name="values"> Value(s) being tested against. The values should be of the same type as the property. In the cases where the property is a collection, the values should be of the same type as the items in the collection. </param> </member> <member name="P:Amazon.DynamoDB.DataModel.ScanCondition.PropertyName"> <summary> Name of the property being tested </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.ScanCondition.Operator"> <summary> Comparison operator </summary> </member> <member name="P:Amazon.DynamoDB.DataModel.ScanCondition.Values"> <summary> Values being tested against. The values should be of the same type as the property. In the cases where the property is a collection, the values should be of the same type as the items in the collection. </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.Document"> <summary> A collection of attribute key-value pairs that defines an item in DynamoDB. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.#ctor"> <summary> Constructs an empty Document. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.IsAttributeChanged(System.String)"> <summary> Returns true if the attribute has been changed. </summary> <param name="attributeName">Name of the attribute.</param> <returns>True if the attribute has been changed.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.IsDirty"> <summary> Returns true if the document contains attributes that have not been saved. </summary> <returns>True if the document contains attributes that have not been saved.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.TryGetValue(System.String,Amazon.DynamoDB.DocumentModel.DynamoDBEntry@)"> <summary> Gets the value associated with the specified attribute value. </summary> <param name="attributeName">Attribute name</param> <param name="entry"> If the specified attribute value is found, returns the value associated with the attribute; otherwise, null. </param> <returns>True if attribute is found; false otherwise</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.Contains(System.String)"> <summary> Determines if a specific attribute is set on the Document. </summary> <param name="attributeName">Attribute name</param> <returns>Returns true if the specified attribute is found; false otherwise.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.ToAttributeMap"> <summary> Creates a map of attribute names mapped to AttributeValue objects. </summary> <returns></returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.ToExpectedAttributeMap"> <summary> Creates a map of attribute names mapped to ExpectedAttributeValue objects. </summary> <returns></returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.ToAttributeUpdateMap(System.Boolean)"> <summary> Creates a map of attribute names mapped to AttributeValueUpdate objects. </summary> <param name="changedAttributesOnly">If true, only attributes that have been changed will be in the map.</param> <returns></returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.GetAttributeNames"> <summary> Returns the names of all the attributes. </summary> <returns>List of attribute names.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Document.FromAttributeMap(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.AttributeValue})"> <summary> Creates a Document from an attribute map. </summary> <param name="data">Map of attribute names to attribute values.</param> <returns>Document representing the data.</returns> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Document.Item(System.String)"> <summary> Attribute accessor, allows getting or setting of an individual attribute. </summary> <param name="key">Name of the attribute.</param> <returns>Current value of the attribute.</returns> </member> <member name="T:Amazon.DynamoDB.DocumentModel.DocumentBatchGet"> <summary> Class for retrieving a batch of Documents from a single DynamoDB table. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DocumentBatchGet.#ctor(Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchGet.AddKey(Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchGet.AddKey(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchGet.Combine(Amazon.DynamoDB.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="M:Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchGet.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.DocumentBatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DocumentBatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.DocumentBatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="P:Amazon.DynamoDB.DocumentModel.DocumentBatchGet.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.DocumentBatchGet.AttributesToGet"> <summary> List of attributes to retrieve. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.DocumentBatchGet.ConsistentRead"> <summary> If set to true, a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchGet"> <summary> Class for retrieving a batch of Documents from multiple DynamoDB tables. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.#ctor(Amazon.DynamoDB.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.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.AddBatch(Amazon.DynamoDB.DocumentModel.DocumentBatchGet)"> <summary> Add a DocumentBatchGet object to the multi-table batch request. </summary> <param name="batch">DocumentBatchGet to add.</param> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="P:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.Batches"> <summary> List of DocumentBatchGet objects to include in the multi-table batch request. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchGet.TotalKeys"> <summary> Total number of primary keys in the multi-table batch request. </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.MultiBatchGet"> <summary> Internal class for handling multi-table batch gets. </summary> </member> <member name="F:Amazon.DynamoDB.DocumentModel.MultiBatchGet.MaxItemsPerCall"> <summary> Maximum number of items that can be sent in a single BatchGet request </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.MultiBatchGet.GetItems"> <summary> Gets items ocnfigured in Batches from the server </summary> <returns></returns> </member> <member name="P:Amazon.DynamoDB.DocumentModel.MultiBatchGet.Batches"> <summary> Batches that comprise the current BatchGet operation </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.DocumentBatchWrite"> <summary> Class for putting and/or deleting a batch of items in a single DynamoDB table. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DocumentBatchWrite.#ctor(Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchWrite.AddKeyToDelete(Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchWrite.AddKeyToDelete(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchWrite.AddItemToDelete(Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchWrite.AddDocumentToPut(Amazon.DynamoDB.DocumentModel.Document)"> <summary> Add a single Document to put. </summary> <param name="document">Document to put.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DocumentBatchWrite.Combine(Amazon.DynamoDB.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="M:Amazon.DynamoDB.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.DynamoDB.DocumentModel.DocumentBatchWrite.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.DocumentBatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DocumentBatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.DocumentBatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="T:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite"> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite.#ctor(Amazon.DynamoDB.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.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite.AddBatch(Amazon.DynamoDB.DocumentModel.DocumentBatchWrite)"> <summary> Add a DocumentBatchWrite object to the multi-table batch request. </summary> <param name="batch">DocumentBatchWrite to add.</param> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite.BeginExecute(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite.Execute"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecute operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite.EndExecute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite.Execute"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecute.</param> </member> <member name="P:Amazon.DynamoDB.DocumentModel.MultiTableDocumentBatchWrite.Batches"> <summary> List of DocumentBatchWrite objects to include in the multi-table batch request. </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.MultiBatchWrite"> <summary> Internal class for handling multi-table batch writes. </summary> </member> <member name="F:Amazon.DynamoDB.DocumentModel.MultiBatchWrite.MaxItemsPerCall"> <summary> Maximum number of items that can be sent in a single BatchWrite request </summary> </member> <member name="F:Amazon.DynamoDB.DocumentModel.MultiBatchWrite.tableMap"> <summary> Map which stores tables by its name. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.MultiBatchWrite.WriteItems(System.Boolean)"> <summary> Pushes items configured in Batches to the server </summary> <param name="isAsync"></param> </member> <member name="P:Amazon.DynamoDB.DocumentModel.MultiBatchWrite.Batches"> <summary> Batches that comprise the current BatchWrite operation </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.DynamoDBEntryType"> <summary> Enumerator describing type of DynamoDB data </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Abstract class representing an arbitrary DynamoDB attribute value </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsPrimitive"> <summary> Convert DynamoDBEntry to Primitive </summary> <returns> Primitive if DynamoDBEntry is of Primitive type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsPrimitiveList"> <summary> Convert DynamoDBEntry to PrimitiveList </summary> <returns> AsPrimitiveList if DynamoDBEntry is of AsPrimitiveList type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsBoolean"> <summary> Explicitly convert DynamoDBEntry to Boolean </summary> <returns>Boolean value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Boolean)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Boolean to DynamoDBEntry </summary> <param name="data">Boolean data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Boolean"> <summary> Explicitly convert DynamoDBEntry to Boolean </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Boolean value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsByte"> <summary> Explicitly convert DynamoDBEntry to Byte </summary> <returns>Byte value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Byte)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Byte to DynamoDBEntry </summary> <param name="data">Byte data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Byte"> <summary> Explicitly convert DynamoDBEntry to Byte </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Byte value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsSByte"> <summary> Explicitly convert DynamoDBEntry to SByte </summary> <returns>SByte value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.SByte)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert SByte to DynamoDBEntry </summary> <param name="data">SByte data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.SByte"> <summary> Explicitly convert DynamoDBEntry to SByte </summary> <param name="p">DynamoDBEntry to convert</param> <returns>SByte value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsUShort"> <summary> Explicitly convert DynamoDBEntry to UInt16 </summary> <returns>UInt16 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.UInt16)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert UInt16 to DynamoDBEntry </summary> <param name="data">UInt16 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.UInt16"> <summary> Explicitly convert DynamoDBEntry to UInt16 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>UInt16 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsShort"> <summary> Explicitly convert DynamoDBEntry to Int16 </summary> <returns>Int16 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Int16)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Int16 to DynamoDBEntry </summary> <param name="data">Int16 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Int16"> <summary> Explicitly convert DynamoDBEntry to Int16 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Int16 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsUInt"> <summary> Explicitly convert DynamoDBEntry to UInt32 </summary> <returns>UInt32 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.UInt32)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert UInt32 to DynamoDBEntry </summary> <param name="data">UInt32 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.UInt32"> <summary> Explicitly convert DynamoDBEntry to UInt32 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>UInt32 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsInt"> <summary> Explicitly convert DynamoDBEntry to Int32 </summary> <returns>Int32 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Int32)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Int32 to DynamoDBEntry </summary> <param name="data">Int32 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Int32"> <summary> Explicitly convert DynamoDBEntry to Int32 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Int32 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsULong"> <summary> Explicitly convert DynamoDBEntry to UInt64 </summary> <returns>UInt64 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.UInt64)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert UInt64 to DynamoDBEntry </summary> <param name="data">UInt64 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.UInt64"> <summary> Explicitly convert DynamoDBEntry to UInt64 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>UInt64 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsLong"> <summary> Explicitly convert DynamoDBEntry to Int64 </summary> <returns>Int64 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Int64)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Int64 to DynamoDBEntry </summary> <param name="data">Int64 data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Int64"> <summary> Explicitly convert DynamoDBEntry to Int64 </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Int64 value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsSingle"> <summary> Explicitly convert DynamoDBEntry to Single </summary> <returns>Single value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Single)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Single to DynamoDBEntry </summary> <param name="data">Single data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Single"> <summary> Explicitly convert DynamoDBEntry to Single </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Single value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsDouble"> <summary> Explicitly convert DynamoDBEntry to Double </summary> <returns>Double value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Double)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Double to DynamoDBEntry </summary> <param name="data">Double data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Double"> <summary> Explicitly convert DynamoDBEntry to Double </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Double value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsDecimal"> <summary> Explicitly convert DynamoDBEntry to Decimal </summary> <returns>Decimal value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Decimal)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Decimal to DynamoDBEntry </summary> <param name="data">Decimal data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Decimal"> <summary> Explicitly convert DynamoDBEntry to Decimal </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Decimal value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsChar"> <summary> Explicitly convert DynamoDBEntry to Char </summary> <returns>Char value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Char)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Char to DynamoDBEntry </summary> <param name="data">Char data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Char"> <summary> Explicitly convert DynamoDBEntry to Char </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Char value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsString"> <summary> Explicitly convert DynamoDBEntry to String </summary> <returns>String value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.String)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert String to DynamoDBEntry </summary> <param name="data">String data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.String"> <summary> Explicitly convert DynamoDBEntry to String </summary> <param name="p">DynamoDBEntry to convert</param> <returns>String value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsDateTime"> <summary> Explicitly convert DynamoDBEntry to DateTime </summary> <returns>DateTime value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.DateTime)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert DateTime to DynamoDBEntry </summary> <param name="data">DateTime data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.DateTime"> <summary> Explicitly convert DynamoDBEntry to DateTime </summary> <param name="p">DynamoDBEntry to convert</param> <returns>DateTime value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsGuid"> <summary> Explicitly convert DynamoDBEntry to Guid </summary> <returns>Guid value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Guid)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Guid to DynamoDBEntry </summary> <param name="data">Guid data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Guid"> <summary> Explicitly convert DynamoDBEntry to Guid </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Guid value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsByteArray"> <summary> Explicitly convert DynamoDBEntry to byte[] </summary> <returns>byte[] value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Byte[])~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert byte[] to DynamoDBEntry </summary> <param name="data">byte[] data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Byte[]"> <summary> Explicitly convert DynamoDBEntry to byte[] </summary> <param name="p">DynamoDBEntry to convert</param> <returns>byte[] value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsMemoryStream"> <summary> Explicitly convert DynamoDBEntry to MemoryStream </summary> <returns>MemoryStream value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.IO.MemoryStream)~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert MemoryStream to DynamoDBEntry </summary> <param name="data">MemoryStream data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.IO.MemoryStream"> <summary> Explicitly convert DynamoDBEntry to MemoryStream </summary> <param name="p">DynamoDBEntry to convert</param> <returns>MemoryStream value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsListOfPrimitives"> <summary> Explicitly convert DynamoDBEntry to List<Primitive> </summary> <returns>List<Primitive> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{Amazon.DynamoDB.DocumentModel.Primitive})~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<Primitive> to DynamoDBEntry </summary> <param name="data">List<Primitive> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{Amazon.DynamoDB.DocumentModel.Primitive}"> <summary> Explicitly convert DynamoDBEntry to List<Primitive> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<Primitive> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsListOfString"> <summary> Explicitly convert DynamoDBEntry to List<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{System.String})~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<String> to DynamoDBEntry </summary> <param name="data">List<String> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{System.String}"> <summary> Explicitly convert DynamoDBEntry to List<String> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<String> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsListOfByteArray"> <summary> Explicitly convert DynamoDBEntry to List<byte[]> </summary> <returns>List<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{System.Byte[]})~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<byte[]> to DynamoDBEntry </summary> <param name="data">List<byte[]> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{System.Byte[]}"> <summary> Explicitly convert DynamoDBEntry to List<byte[]> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<byte[]> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.AsListOfMemoryStream"> <summary> Explicitly convert DynamoDBEntry to List<MemoryStream> </summary> <returns>List<MemoryStream> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{System.IO.MemoryStream})~Amazon.DynamoDB.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<MemoryStream> to DynamoDBEntry </summary> <param name="data">List<MemoryStream> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.DynamoDBEntry.op_Explicit(Amazon.DynamoDB.DocumentModel.DynamoDBEntry)~System.Collections.Generic.List{System.IO.MemoryStream}"> <summary> Explicitly convert DynamoDBEntry to List<MemoryStream> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<MemoryStream> value of DynamoDBEntry</returns> </member> <member name="T:Amazon.DynamoDB.DocumentModel.Filter"> <summary> Abstract filter class </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.ScanFilter"> <summary> Filter for use with scan operations </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanFilter.ToConditions"> <summary> Converts filter to a map of conditions </summary> <returns>Map from attribute name to condition</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanFilter.FromConditions(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.Condition})"> <summary> Creates a ScanFilter from a conditions map </summary> <param name="conditions">Map from attribute name to condition</param> <returns>Equivalent ScanFilter</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanFilter.op_Implicit(Amazon.DynamoDB.DocumentModel.ScanFilter)~System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.Condition}"> <summary> Implicitly converts ScanFilter to map of conditions </summary> <param name="f">ScanFilter to convert</param> <returns>Map from attribute name to condition</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanFilter.op_Implicit(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.Condition})~Amazon.DynamoDB.DocumentModel.ScanFilter"> <summary> Implicitly converts map of conditions to ScanFilter </summary> <param name="conditions">Map from attribute name to condition</param> <returns>Equivalent ScanFilter</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanFilter.AddCondition(System.String,Amazon.DynamoDB.Model.Condition)"> <summary> Adds a condition for a specified attribute. If a condition for the attribute already exists, it will be replaced with the new condition. </summary> <param name="attributeName">Target attribute name</param> <param name="condition">Condition to be added</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanFilter.AddCondition(System.String,Amazon.DynamoDB.DocumentModel.ScanOperator,System.Collections.Generic.List{Amazon.DynamoDB.Model.AttributeValue})"> <summary> Adds a condition for a specified attribute that consists of an operator and any number of AttributeValues. </summary> <param name="attributeName">Target attribute name</param> <param name="op">Comparison operator</param> <param name="values">AttributeValues to compare to</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanFilter.AddCondition(System.String,Amazon.DynamoDB.DocumentModel.ScanOperator,Amazon.DynamoDB.DocumentModel.DynamoDBEntry[])"> <summary> Adds a condition for a specified attribute that consists of an operator and any number of values </summary> <param name="attributeName">Target attribute name</param> <param name="op">Comparison operator</param> <param name="values">Values to compare to</param> </member> <member name="T:Amazon.DynamoDB.DocumentModel.RangeFilter"> <summary> Filter for use with range (query) searches </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.RangeFilter.#ctor"> <summary> Constructs RangeFilter with no condition </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.RangeFilter.#ctor(Amazon.DynamoDB.Model.Condition)"> <summary> Constructs RangeFilter with the specified condition </summary> <param name="cond"></param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.RangeFilter.#ctor(Amazon.DynamoDB.DocumentModel.QueryOperator,Amazon.DynamoDB.DocumentModel.Primitive[])"> <summary> Constructs RangeFilter with the specified comparison operator and comparison values </summary> <param name="op">Comparison operator</param> <param name="values">Values to compare against</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.RangeFilter.#ctor(Amazon.DynamoDB.DocumentModel.QueryOperator,System.Collections.Generic.List{Amazon.DynamoDB.Model.AttributeValue})"> <summary> Constructs RangeFilter with the specified comparison operator and comparison values </summary> <param name="op">Comparison operator</param> <param name="values">Values to compare against</param> </member> <member name="P:Amazon.DynamoDB.DocumentModel.RangeFilter.Condition"> <summary> Condition to test with the filter </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.Primitive"> <summary> A DynamoDBEntry that represents a primitive DynamoDB type </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.#ctor"> <summary> Constructs an empty Primitive </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.#ctor(System.String)"> <summary> Constructs a Primitive with the specified value. Value is stored as a string, not numeric. </summary> <param name="value">Value of the Primitive</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.#ctor(System.String,System.Boolean)"> <summary> Constructs a Primitive with the specified value and specifies whether it should be stored as a number or not. </summary> <param name="value">Value of the Primitive</param> <param name="saveAsNumeric"> Flag, set to true if value should be treated as a number instead of a string </param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.#ctor(System.IO.MemoryStream)"> <summary> Constructs a Binary Primitive with the specified MemoryStream value. Note: Primitive's Value is set to the stream's ToArray() response. </summary> <param name="value">Value of the Primitive</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.#ctor(System.Byte[])"> <summary> Constructs a Binary Primitive with the specified byte[] value. </summary> <param name="value">Value of the Primitive</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsBoolean"> <summary> Explicitly convert Primitive to Boolean </summary> <returns>Boolean value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Boolean)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Boolean to Primitive </summary> <param name="data">Boolean data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Boolean"> <summary> Explicitly convert Primitive to Boolean </summary> <param name="p">Primitive to convert</param> <returns>Boolean value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsByte"> <summary> Explicitly convert Primitive to Byte </summary> <returns>Byte value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Byte)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Byte to Primitive </summary> <param name="data">Byte data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Byte"> <summary> Explicitly convert Primitive to Byte </summary> <param name="p">Primitive to convert</param> <returns>Byte value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsSByte"> <summary> Explicitly convert Primitive to SByte </summary> <returns>SByte value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.SByte)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert SByte to Primitive </summary> <param name="data">SByte data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.SByte"> <summary> Explicitly convert Primitive to SByte </summary> <param name="p">Primitive to convert</param> <returns>SByte value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsUShort"> <summary> Explicitly convert Primitive to UInt16 </summary> <returns>UInt16 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.UInt16)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert UInt16 to Primitive </summary> <param name="data">UInt16 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.UInt16"> <summary> Explicitly convert Primitive to UInt16 </summary> <param name="p">Primitive to convert</param> <returns>UInt16 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsShort"> <summary> Explicitly convert Primitive to Int16 </summary> <returns>Int16 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Int16)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Int16 to Primitive </summary> <param name="data">Int16 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Int16"> <summary> Explicitly convert Primitive to Int16 </summary> <param name="p">Primitive to convert</param> <returns>Int16 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsUInt"> <summary> Explicitly convert Primitive to UInt32 </summary> <returns>UInt32 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.UInt32)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert UInt32 to Primitive </summary> <param name="data">UInt32 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.UInt32"> <summary> Explicitly convert Primitive to UInt32 </summary> <param name="p">Primitive to convert</param> <returns>UInt32 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsInt"> <summary> Explicitly convert Primitive to Int32 </summary> <returns>Int32 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Int32)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Int32 to Primitive </summary> <param name="data">Int32 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Int32"> <summary> Explicitly convert Primitive to Int32 </summary> <param name="p">Primitive to convert</param> <returns>Int32 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsULong"> <summary> Explicitly convert Primitive to UInt64 </summary> <returns>UInt64 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.UInt64)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert UInt64 to Primitive </summary> <param name="data">UInt64 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.UInt64"> <summary> Explicitly convert Primitive to UInt64 </summary> <param name="p">Primitive to convert</param> <returns>UInt64 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsLong"> <summary> Explicitly convert Primitive to Int64 </summary> <returns>Int64 value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Int64)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Int64 to Primitive </summary> <param name="data">Int64 data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Int64"> <summary> Explicitly convert Primitive to Int64 </summary> <param name="p">Primitive to convert</param> <returns>Int64 value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsSingle"> <summary> Explicitly convert Primitive to Single </summary> <returns>Single value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Single)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Single to Primitive </summary> <param name="data">Single data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Single"> <summary> Explicitly convert Primitive to Single </summary> <param name="p">Primitive to convert</param> <returns>Single value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsDouble"> <summary> Explicitly convert Primitive to Double </summary> <returns>Double value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Double)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Double to Primitive </summary> <param name="data">Double data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Double"> <summary> Explicitly convert Primitive to Double </summary> <param name="p">Primitive to convert</param> <returns>Double value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsDecimal"> <summary> Explicitly convert Primitive to Decimal </summary> <returns>Decimal value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Decimal)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Decimal to Primitive </summary> <param name="data">Decimal data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Decimal"> <summary> Explicitly convert Primitive to Decimal </summary> <param name="p">Primitive to convert</param> <returns>Decimal value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsChar"> <summary> Explicitly convert Primitive to Char </summary> <returns>Char value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Char)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Char to Primitive </summary> <param name="data">Char data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Char"> <summary> Explicitly convert Primitive to Char </summary> <param name="p">Primitive to convert</param> <returns>Char value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsString"> <summary> Explicitly convert Primitive to String </summary> <returns>String value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.String)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert String to Primitive </summary> <param name="data">String data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.String"> <summary> Explicitly convert Primitive to String </summary> <param name="p">Primitive to convert</param> <returns>String value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsDateTime"> <summary> Explicitly convert Primitive to DateTime </summary> <returns>DateTime value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.DateTime)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert DateTime to Primitive </summary> <param name="data">DateTime data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.DateTime"> <summary> Explicitly convert Primitive to DateTime </summary> <param name="p">Primitive to convert</param> <returns>DateTime value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsGuid"> <summary> Explicitly convert Primitive to Guid </summary> <returns>Guid value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Guid)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert Guid to Primitive </summary> <param name="data">Guid data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Guid"> <summary> Explicitly convert Primitive to Guid </summary> <param name="p">Primitive to convert</param> <returns>Guid value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsByteArray"> <summary> Explicitly convert Primitive to byte[] </summary> <returns>byte[] value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.Byte[])~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert byte[] to Primitive </summary> <param name="data">byte[] data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.Byte[]"> <summary> Explicitly convert Primitive to byte[] </summary> <param name="p">Primitive to convert</param> <returns>byte[] value of Primitive</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.AsMemoryStream"> <summary> Explicitly convert Primitive to MemoryStream </summary> <returns>MemoryStream value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Implicit(System.IO.MemoryStream)~Amazon.DynamoDB.DocumentModel.Primitive"> <summary> Implicitly convert MemoryStream to Primitive </summary> <param name="data">MemoryStream data to convert</param> <returns>Primitive representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Primitive.op_Explicit(Amazon.DynamoDB.DocumentModel.Primitive)~System.IO.MemoryStream"> <summary> Explicitly convert Primitive to MemoryStream </summary> <param name="p">Primitive to convert</param> <returns>MemoryStream value of Primitive</returns> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Primitive.Value"> <summary> Value of the Primitive. If Type is String or Numeric, this property is a string. If Type is Binary, this property is a byte array. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Primitive.Type"> <summary> Type of this primitive object </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.PrimitiveList"> <summary> A DynamoDBEntry that represents a primitive list DynamoDB type </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.#ctor"> <summary> Constructs an empty PrimitiveList. Values are configured to be saved as strings. </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.#ctor(Amazon.DynamoDB.DocumentModel.DynamoDBEntryType)"> <summary> Constructs an empty PrimitiveList and specifies the type of its elements. </summary> <param name="type"></param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.Add(Amazon.DynamoDB.DocumentModel.Primitive)"> <summary> Adds a Primitive to the end of the list. </summary> <param name="value">Primitive to add.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.AsListOfPrimitives"> <summary> Explicitly convert PrimitiveList to List<Primitive> </summary> <returns>List<Primitive> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{Amazon.DynamoDB.DocumentModel.Primitive})~Amazon.DynamoDB.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<Primitive> to PrimitiveList </summary> <param name="data">List<Primitive> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDB.DocumentModel.PrimitiveList)~System.Collections.Generic.List{Amazon.DynamoDB.DocumentModel.Primitive}"> <summary> Explicitly convert PrimitiveList to List<Primitive> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<Primitive> value of PrimitiveList</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.AsListOfString"> <summary> Explicitly convert PrimitiveList to List<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{System.String})~Amazon.DynamoDB.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<String> to PrimitiveList </summary> <param name="data">List<String> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDB.DocumentModel.PrimitiveList)~System.Collections.Generic.List{System.String}"> <summary> Explicitly convert PrimitiveList to List<String> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<String> value of PrimitiveList</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.AsListOfByteArray"> <summary> Explicitly convert PrimitiveList to byte[] </summary> <returns>List<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{System.Byte[]})~Amazon.DynamoDB.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<byte[]> to PrimitiveList </summary> <param name="data">List<byte[]> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDB.DocumentModel.PrimitiveList)~System.Collections.Generic.List{System.Byte[]}"> <summary> Explicitly convert PrimitiveList to List<byte[]> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<byte[]> value of PrimitiveList</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.AsListOfMemoryStream"> <summary> Explicitly convert PrimitiveList to List<MemoryStream> </summary> <returns>List<MemoryStream> value of this object</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.List{System.IO.MemoryStream})~Amazon.DynamoDB.DocumentModel.PrimitiveList"> <summary> Implicitly convert List<MemoryStream> to PrimitiveList </summary> <param name="data">List<MemoryStream> data to convert</param> <returns>PrimitiveList representing the data</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDB.DocumentModel.PrimitiveList)~System.Collections.Generic.List{System.IO.MemoryStream}"> <summary> Explicitly convert PrimitiveList to List<MemoryStream> </summary> <param name="p">PrimitiveList to convert</param> <returns>List<MemoryStream> value of PrimitiveList</returns> </member> <member name="P:Amazon.DynamoDB.DocumentModel.PrimitiveList.Entries"> <summary> Collection of Primitive entries </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.PrimitiveList.Type"> <summary> Type of Primitive items in the list </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.PrimitiveList.Item(System.Int32)"> <summary> Gets or sets Primitive at a specific location in the list. </summary> <param name="i">Index of the Primitive in question.</param> <returns>Primitive in question.</returns> </member> <member name="T:Amazon.DynamoDB.DocumentModel.Search"> <summary> Search response object </summary> </member> <member name="M:Amazon.DynamoDB.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.DynamoDB.DocumentModel.Search.GetRemaining"> <summary> Retrieves all the remaining results </summary> <returns>List of Documents matching the search parameters</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Search.BeginGetNextSet(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetNextSet operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Search.GetNextSet"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetNextSet operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Search.EndGetNextSet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Execute operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Search.GetNextSet"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetNextSet.</param> <returns>Next set of Documents matching the search parameters</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Search.BeginGetRemaining(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRemaining operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Search.GetRemaining"/> </summary> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRemaining operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Search.EndGetRemaining(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRemaining operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Search.GetRemaining"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRemaining.</param> <returns>List of Documents matching the search parameters</returns> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.TableName"> <summary> Name of the table being searched </summary> </member> <member name="P:Amazon.DynamoDB.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.DynamoDB.DocumentModel.Search.Filter"> <summary> Filter for the search operation </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.AttributesToGet"> <summary> List of attribute names to retrieve </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.IsConsistentRead"> <summary> Flag that, if true, indicates that the search is operating in consistent-read mode </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.HashKey"> <summary> HashKey value associated with the search </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.IsBackwardSearch"> <summary> Flag that, if true, indicates that the search is traversing backwards </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.IsDone"> <summary> Flag that, if true, indicates that the search is done </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.NextKey"> <summary> Key denoting the starting point of the next set of results </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.Matches"> <summary> List of currently found items </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Search.Count"> <summary> Gets the total number of items that match the search parameters If IsDone 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="M:Amazon.DynamoDB.DocumentModel.Table.LoadTable(Amazon.DynamoDB.AmazonDynamoDB,System.String)"> <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> <returns>Table object representing the specified table.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.TryLoadTable(Amazon.DynamoDB.AmazonDynamoDB,System.String,Amazon.DynamoDB.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="table">Loaded table.</param> <returns> True if table was successfully loaded; otherwise false. </returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.PutItem(Amazon.DynamoDB.DocumentModel.Document)"> <summary> Puts a document into DynamoDB. </summary> <param name="doc">Document to save.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.PutItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.PutItemOperationConfig)"> <summary> Puts a document into DynamoDB, using specified 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.DynamoDB.DocumentModel.Table.BeginPutItem(Amazon.DynamoDB.DocumentModel.Document,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.PutItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="doc">Document to save.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginPutItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.PutItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.PutItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="doc">Document to save.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.EndPutItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.PutItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Null or updated attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive)"> <summary> Gets a document from DynamoDB by hash primary key. </summary> <param name="hashKey">Hash key element of the document.</param> <returns>Document from DynamoDB</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive)"> <summary> Gets a document from DynamoDB by hash-and-range primary key. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <returns>Document from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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.DynamoDB.DocumentModel.Table.BeginGetItem(Amazon.DynamoDB.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginGetItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginGetItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.GetItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginGetItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.GetItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.EndGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.GetItem(Amazon.DynamoDB.DocumentModel.Primitive)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Document from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"> <summary> Update a document in DynamoDB. </summary> <param name="doc">Document to update.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive)"> <summary> Update a document in DynamoDB, with hash primary key to identify the document. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive)"> <summary> Update a document in DynamoDB, with a hash-and-range primary key to identify the document. </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> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.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.DynamoDB.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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.DynamoDB.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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.DynamoDB.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDB.DocumentModel.Document,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="doc">Document to update.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.UpdateItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="doc">Document to update.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.UpdateItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginUpdateItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.UpdateItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.EndUpdateItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.UpdateItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Null or updated attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"> <summary> Delete a document in DynamoDB. </summary> <param name="document">Document to delete.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Primitive)"> <summary> Delete a document in DynamoDB, identified by a hash primary key. </summary> <param name="hashKey">Hash key element of the document.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive)"> <summary> Delete a document in DynamoDB, identified by a hash-and-range primary key. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.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>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.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>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDB.DocumentModel.Document,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="document">Document to delete.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDB.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDB.DocumentModel.Document,Amazon.DynamoDB.DocumentModel.DeleteItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="document">Document to delete.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.DeleteItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.BeginDeleteItem(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.DeleteItemOperationConfig,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"/> </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="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteItem operation.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.EndDeleteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteItem operation. <seealso cref="M:Amazon.DynamoDB.DocumentModel.Table.DeleteItem(Amazon.DynamoDB.DocumentModel.Document)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.Scan(Amazon.DynamoDB.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.DynamoDB.DocumentModel.Table.Scan(Amazon.DynamoDB.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.DynamoDB.DocumentModel.Table.Query(Amazon.DynamoDB.DocumentModel.Primitive,Amazon.DynamoDB.DocumentModel.RangeFilter)"> <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">Hash key element parameter of the query.</param> <param name="filter">Filter to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDB.DocumentModel.Table.Query(Amazon.DynamoDB.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.DynamoDB.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.DynamoDB.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.DynamoDB.DocumentModel.Table.TableName"> <summary> Name of the table. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Table.HashKeyName"> <summary> Name of the hash key element for the table. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Table.RangeKeyName"> <summary> Name of the range key element for the table. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Table.HashKeyType"> <summary> Type of the hash key for the table. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Table.RangeKeyType"> <summary> Type of the range key for the table. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Table.HashKeyIsNumeric"> <summary> Flag that signals if the hash key element is a numeric. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Table.RangeKeyIsNumeric"> <summary> Flag that signals if the range key element is a numeric. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.Table.RangeKeyIsDefined"> <summary> Flag that signals if the range key element is present on the table. </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.PutItemOperationConfig"> <summary> Configuration for the Table.PutItem operation </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.PutItemOperationConfig.Expected"> <summary> Document representing the expected state </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.PutItemOperationConfig.ReturnValues"> <summary> Flag specifying what values should be returned. PutItem only supports ReturnValues.AllOldAttributes and ReturnValues.None </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.GetItemOperationConfig"> <summary> Configuration for the Table.GetItem operation </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.GetItemOperationConfig.AttributesToGet"> <summary> List of attributes to retrieve </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.GetItemOperationConfig.ConsistentRead"> <summary> If set to true, this flag ensures that the most recently written data is returned. </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.UpdateItemOperationConfig"> <summary> Configuration for the Table.UpdateItem operation </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.UpdateItemOperationConfig.Expected"> <summary> Document representing the expected state </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.UpdateItemOperationConfig.ReturnValues"> <summary> Flag specifying what values should be returned. </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.DeleteItemOperationConfig"> <summary> Configuration for the Table.DeleteItem operation </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.DeleteItemOperationConfig.Expected"> <summary> Document representing the expected state </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.DeleteItemOperationConfig.ReturnValues"> <summary> Flag specifying what values should be returned. DeleteItem only supports ReturnValues.AllOldAttributes and ReturnValues.None </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.ScanOperationConfig"> <summary> Configuration for the Table.Scan operation </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.ScanOperationConfig.#ctor"> <summary> Initializes a default Table.Scan config object Filter is empty, Limit is Int32.MaxValue </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.ScanOperationConfig.AttributesToGet"> <summary> List of attributes to retrieve as part of the search </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.ScanOperationConfig.Limit"> <summary> Upper limit on the number of items scanned per request for matching conditions. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.ScanOperationConfig.Filter"> <summary> Filter for the search operation </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.QueryOperationConfig"> <summary> Configuration for the Table.Query operation </summary> </member> <member name="M:Amazon.DynamoDB.DocumentModel.QueryOperationConfig.#ctor"> <summary> Initializes a default Table.Query config object Filter is empty, Limit is Int32.MaxValue </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.QueryOperationConfig.HashKey"> <summary> HashKey value associated with the search </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.QueryOperationConfig.Filter"> <summary> Filter for the search operation </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.QueryOperationConfig.ConsistentRead"> <summary> If set to true, this flag ensures that the most recently written data is returned. </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.QueryOperationConfig.AttributesToGet"> <summary> List of attributes to retrieve as part of the search </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.QueryOperationConfig.Limit"> <summary> Upper limit on the number of items to return per request </summary> </member> <member name="P:Amazon.DynamoDB.DocumentModel.QueryOperationConfig.BackwardSearch"> <summary> Flag that signals if the search is traversing backwards </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.ReturnValues"> <summary> An enumeration of all supported return value directives </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.ScanOperator"> <summary> An enumeration of all supported scan operator directives </summary> </member> <member name="T:Amazon.DynamoDB.DocumentModel.QueryOperator"> <summary> An enumeration of all supported query operator directives </summary> </member> <member name="T:Amazon.DynamoDB.Model.AttributeValue"> <summary> <para>AttributeValue can be <c>String</c> , <c>Number</c> , <c>Binary</c> , <c>StringSet</c> , <c>NumberSet</c> , <c>BinarySet</c> .</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithS(System.String)"> <summary> Sets the S property </summary> <param name="s">The value to set for the S property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithN(System.String)"> <summary> Sets the N property </summary> <param name="n">The value to set for the N property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithB(System.IO.MemoryStream)"> <summary> Sets the B property </summary> <param name="b">The value to set for the B property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithSS(System.String[])"> <summary> Adds elements to the SS collection </summary> <param name="sS">The values to add to the SS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithSS(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SS collection </summary> <param name="sS">The values to add to the SS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithNS(System.String[])"> <summary> Adds elements to the NS collection </summary> <param name="nS">The values to add to the NS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithNS(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the NS collection </summary> <param name="nS">The values to add to the NS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithBS(System.IO.MemoryStream[])"> <summary> Adds elements to the BS collection </summary> <param name="bS">The values to add to the BS collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValue.WithBS(System.Collections.Generic.IEnumerable{System.IO.MemoryStream})"> <summary> Adds elements to the BS collection </summary> <param name="bS">The values to add to the BS collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValue.S"> <summary> Strings are Unicode with UTF-8 binary encoding. The maximum size is limited by the size of the primary key (1024 bytes as a range part of a key or 2048 bytes as a single part hash key) or the item size (64k). </summary> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValue.N"> <summary> Numbers are positive or negative exact-value decimals and integers. A number can have up to 38 digits precision and can be between 10^-128 to 10^+126. </summary> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValue.B"> <summary> Binary attributes are sequences of unsigned bytes. </summary> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValue.SS"> <summary> A set of strings. </summary> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValue.NS"> <summary> A set of numbers. </summary> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValue.BS"> <summary> A set of binary attributes. </summary> </member> <member name="T:Amazon.DynamoDB.Model.AttributeValueUpdate"> <summary> <para>Specifies the attribute to update and how to perform the update. Possible values: <c>PUT</c> (default), <c>ADD</c> or <c>DELETE</c> .</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValueUpdate.WithValue(Amazon.DynamoDB.Model.AttributeValue)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.AttributeValueUpdate.WithAction(System.String)"> <summary> Sets the Action property </summary> <param name="action">The value to set for the Action property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValueUpdate.Value"> <summary> AttributeValue can be <c>String</c>, <c>Number</c>, <c>Binary</c>, <c>StringSet</c>, <c>NumberSet</c>, <c>BinarySet</c>. </summary> </member> <member name="P:Amazon.DynamoDB.Model.AttributeValueUpdate.Action"> <summary> The type of action for an item update operation. Only use the add action for numbers or sets; the specified value is added to the existing value. If a set of values is specified, the values are added to the existing set. Adds the specified attribute. If the attribute exists, it is replaced by the new value. If no value is specified, this removes the attribute and its value. If a set of values is specified, then the values in the specified set are removed from the old set. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ADD, PUT, DELETE</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchGetItemRequest"> <summary> Container for the parameters to the BatchGetItem operation. <para>Retrieves the attributes for multiple items from multiple tables using their primary keys.</para> <para>The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial result is returned due to an internal processing failure, Amazon DynamoDB returns an <c>UnprocessedKeys</c> value so you can retry the operation starting with the next item to get.</para> <para>Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50k in size, the system returns 20 items and an appropriate <c>UnprocessedKeys</c> value so you can get the next page of results. If necessary, your application needs its own logic to assemble the pages of results into one set.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchGetItem(Amazon.DynamoDB.Model.BatchGetItemRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.BatchGetItemRequest.WithRequestItems(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.KeysAndAttributes}[])"> <summary> Adds the KeyValuePairs to the RequestItems dictionary. </summary> <param name="pairs">The pairs to be added to the RequestItems dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.BatchGetItemRequest.RequestItems"> <summary> A map of the table name and corresponding items to get by primary key. While requesting items, each table name can be invoked only once per operation. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchGetItemResponse"> <summary> Returns information about the BatchGetItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.BatchGetItemResponse.BatchGetItemResult"> <summary> Gets and sets the BatchGetItemResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchGetItemResult"> <summary>Batch Get Item Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.BatchGetItemResult.WithResponses(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.BatchResponse}[])"> <summary> Adds the KeyValuePairs to the Responses dictionary. </summary> <param name="pairs">The pairs to be added to the Responses dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.BatchGetItemResult.WithUnprocessedKeys(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.KeysAndAttributes}[])"> <summary> Adds the KeyValuePairs to the UnprocessedKeys dictionary. </summary> <param name="pairs">The pairs to be added to the UnprocessedKeys dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.BatchGetItemResult.Responses"> <summary> Table names and the respective item attributes from the tables. </summary> </member> <member name="P:Amazon.DynamoDB.Model.BatchGetItemResult.UnprocessedKeys"> <summary> Contains a map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. The <c>UnprocessedKeys</c> value is in the same form as a <c>RequestItems</c> parameter (so the value can be provided directly to a subsequent <c>BatchGetItem</c> operation). For more information, see the above <c>RequestItems</c> parameter. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchResponse"> <summary> <para>The item attributes from a response in a specific table, along with the read resources consumed on the table during the request.</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.BatchResponse.WithItems(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.BatchResponse.WithItems(System.Collections.Generic.IEnumerable{System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.AttributeValue}})"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.BatchResponse.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.BatchResponse.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchWriteItemRequest"> <summary> Container for the parameters to the BatchWriteItem operation. <para>Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.</para> <para>There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.BatchWriteItem(Amazon.DynamoDB.Model.BatchWriteItemRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.BatchWriteItemRequest.WithRequestItems(System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.List{Amazon.DynamoDB.Model.WriteRequest}}[])"> <summary> Adds the KeyValuePairs to the RequestItems dictionary. </summary> <param name="pairs">The pairs to be added to the RequestItems dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.BatchWriteItemRequest.RequestItems"> <summary> A map of table name to list-of-write-requests. Used as input to the <c>BatchWriteItem</c> API call <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 25</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchWriteItemResponse"> <summary> Returns information about the BatchWriteItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.BatchWriteItemResponse.BatchWriteItemResult"> <summary> Gets and sets the BatchWriteItemResult property. A container for BatchWriteItem response </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchWriteItemResult"> <summary> <para>A container for <c>BatchWriteItem</c> response</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.BatchWriteItemResult.WithResponses(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.BatchWriteResponse}[])"> <summary> Adds the KeyValuePairs to the Responses dictionary. </summary> <param name="pairs">The pairs to be added to the Responses dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.BatchWriteItemResult.WithUnprocessedItems(System.Collections.Generic.KeyValuePair{System.String,System.Collections.Generic.List{Amazon.DynamoDB.Model.WriteRequest}}[])"> <summary> Adds the KeyValuePairs to the UnprocessedItems dictionary. </summary> <param name="pairs">The pairs to be added to the UnprocessedItems dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.BatchWriteItemResult.Responses"> <summary> The response object as a result of <c>BatchWriteItem</c> call. This is essentially a map of table name to <c>ConsumedCapacityUnits</c>. </summary> </member> <member name="P:Amazon.DynamoDB.Model.BatchWriteItemResult.UnprocessedItems"> <summary> The Items which we could not successfully process in a <c>BatchWriteItem</c> call is returned as <c>UnprocessedItems</c> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 25</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.BatchWriteResponse"> <summary>Batch Write Response </summary> </member> <member name="M:Amazon.DynamoDB.Model.BatchWriteResponse.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.BatchWriteResponse.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.Condition"> <summary>Condition </summary> </member> <member name="M:Amazon.DynamoDB.Model.Condition.WithAttributeValueList(Amazon.DynamoDB.Model.AttributeValue[])"> <summary> Adds elements to the AttributeValueList collection </summary> <param name="attributeValueList">The values to add to the AttributeValueList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.Condition.WithAttributeValueList(System.Collections.Generic.IEnumerable{Amazon.DynamoDB.Model.AttributeValue})"> <summary> Adds elements to the AttributeValueList collection </summary> <param name="attributeValueList">The values to add to the AttributeValueList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.Condition.WithComparisonOperator(System.String)"> <summary> Sets the ComparisonOperator property </summary> <param name="comparisonOperator">The value to set for the ComparisonOperator property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.Condition.AttributeValueList"> <summary> A list of attribute values to be used with a comparison operator for a scan or query operation. For comparisons that require more than one value, such as a <c>BETWEEN</c> comparison, the AttributeValueList contains two attribute values and the comparison operator. </summary> </member> <member name="P:Amazon.DynamoDB.Model.Condition.ComparisonOperator"> <summary> A comparison operator is an enumeration of several operations: <ul> <li><c>EQ</c> for <em>equal</em>.</li> <li><c>NE</c> for <em>not equal</em>.</li> <li><c>IN</c> checks for exact matches.</li> <li><c>LE</c> for <em>less than or equal to</em>.</li> <li><c>LT</c> for <em>less than</em>.</li> <li><c>GE</c> for <em>greater than or equal to</em>.</li> <li><c>GT</c> for <em>greater than</em>.</li> <li><c>BETWEEN</c> for <em>between</em>.</li> <li><c>NOT_NULL</c> for <em>exists</em>.</li> <li><c>NULL</c> for <em>not exists</em>.</li> <li><c>CONTAINS</c> for substring or value in a set.</li> <li><c>NOT_CONTAINS</c> for absence of a substring or absence of a value in a set.</li> <li><c>BEGINS_WITH</c> for a substring prefix.</li> </ul> Scan operations support all available comparison operators. Query operations support a subset of the available comparison operators: EQ, LE, LT, GE, GT, BETWEEN, and BEGINS_WITH. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.ConditionalCheckFailedException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDB.Model.ConditionalCheckFailedException.#ctor(System.String)"> <summary> Constructs a new ConditionalCheckFailedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDB.Model.CreateTableRequest"> <summary> Container for the parameters to the CreateTable operation. <para>Adds a new table to your account.</para> <para>The table name must be unique among those associated with the AWS Account issuing the request, and the AWS Region that receives the request (e.g. <c>us-east-1</c> ).</para> <para>The <c>CreateTable</c> operation triggers an asynchronous workflow to begin creating the table. Amazon DynamoDB immediately returns the state of the table ( <c>CREATING</c> ) until the table is in the <c>ACTIVE</c> state. Once the table is in the <c>ACTIVE</c> state, you can perform data plane operations.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.CreateTable(Amazon.DynamoDB.Model.CreateTableRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.CreateTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.CreateTableRequest.WithKeySchema(Amazon.DynamoDB.Model.KeySchema)"> <summary> Sets the KeySchema property </summary> <param name="keySchema">The value to set for the KeySchema property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.CreateTableRequest.WithProvisionedThroughput(Amazon.DynamoDB.Model.ProvisionedThroughput)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.CreateTableRequest.TableName"> <summary> The name of the table you want to create. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.CreateTableRequest.KeySchema"> <summary> The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a <c>HashKeyElement</c>. A composite hash-and-range primary key contains two attribute values: a <c>HashKeyElement</c> and a <c>RangeKeyElement</c>. </summary> </member> <member name="P:Amazon.DynamoDB.Model.CreateTableRequest.ProvisionedThroughput"> <summary> Provisioned throughput reserves the required read and write resources for your table in terms of <c>ReadCapacityUnits</c> and <c>WriteCapacityUnits</c>. Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads. </summary> </member> <member name="T:Amazon.DynamoDB.Model.CreateTableResponse"> <summary> Returns information about the CreateTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.CreateTableResponse.CreateTableResult"> <summary> Gets and sets the CreateTableResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.CreateTableResult"> <summary>Create Table Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.CreateTableResult.WithTableDescription(Amazon.DynamoDB.Model.TableDescription)"> <summary> Sets the TableDescription property </summary> <param name="tableDescription">The value to set for the TableDescription property </param> <returns>this instance</returns> </member> <member name="T:Amazon.DynamoDB.Model.DeleteItemRequest"> <summary> Container for the parameters to the DeleteItem operation. <para>Deletes a single item in a table by primary key.</para> <para>You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteItem(Amazon.DynamoDB.Model.DeleteItemRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.DeleteItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.DeleteItemRequest.WithKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.DeleteItemRequest.WithExpected(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.ExpectedAttributeValue}[])"> <summary> Adds the KeyValuePairs to the Expected dictionary. </summary> <param name="pairs">The pairs to be added to the Expected dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.DeleteItemRequest.WithReturnValues(System.String)"> <summary> Sets the ReturnValues property </summary> <param name="returnValues">The value to set for the ReturnValues property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.DeleteItemRequest.TableName"> <summary> The name of the table in which you want to delete an item. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.DeleteItemRequest.Key"> <summary> The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key. </summary> </member> <member name="P:Amazon.DynamoDB.Model.DeleteItemRequest.Expected"> <summary> Designates an attribute for a conditional modification. The <c>Expected</c> parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it. </summary> </member> <member name="P:Amazon.DynamoDB.Model.DeleteItemRequest.ReturnValues"> <summary> Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For <c>PUT</c> operations, the possible parameter values are <c>NONE</c> (default) or <c>ALL_OLD</c>. For update operations, the possible parameter values are <c>NONE</c> (default) or <c>ALL_OLD</c>, <c>UPDATED_OLD</c>, <c>ALL_NEW</c> or <c>UPDATED_NEW</c>. <ul> <li><c>NONE</c>: Nothing is returned.</li> <li><c>ALL_OLD</c>: Returns the attributes of the item as they were before the operation.</li> <li><c>UPDATED_OLD</c>: Returns the values of the updated attributes, only, as they were before the operation.</li> <li><c>ALL_NEW</c>: Returns all the attributes and their new values after the operation.</li> <li><c>UPDATED_NEW</c>: Returns the values of the updated attributes, only, as they are after the operation.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.DeleteItemResponse"> <summary> Returns information about the DeleteItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.DeleteItemResponse.DeleteItemResult"> <summary> Gets and sets the DeleteItemResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.DeleteItemResult"> <summary>Delete Item Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.DeleteItemResult.WithAttributes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Attributes dictionary. </summary> <param name="pairs">The pairs to be added to the Attributes dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.DeleteItemResult.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.DeleteItemResult.Attributes"> <summary> If the <c>ReturnValues</c> parameter is provided as <c>ALL_OLD</c> in the request, Amazon DynamoDB returns an array of attribute name-value pairs (essentially, the deleted item). Otherwise, the response contains an empty set. </summary> </member> <member name="P:Amazon.DynamoDB.Model.DeleteItemResult.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.DeleteRequest"> <summary> <para>A container for a Delete BatchWrite request</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.DeleteRequest.WithKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.DeleteRequest.Key"> <summary> The item's key to be delete </summary> </member> <member name="T:Amazon.DynamoDB.Model.DeleteTableRequest"> <summary> Container for the parameters to the DeleteTable operation. <para>Deletes a table and all of its items.</para> <para>If the table is in the <c>ACTIVE</c> state, you can delete it. If a table is in <c>CREATING</c> or <c>UPDATING</c> states then Amazon DynamoDB returns a <c>ResourceInUseException</c> . If the specified table does not exist, Amazon DynamoDB returns a <c>ResourceNotFoundException</c> .</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DeleteTable(Amazon.DynamoDB.Model.DeleteTableRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.DeleteTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.DeleteTableRequest.TableName"> <summary> The name of the table you want to delete. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.DeleteTableResponse"> <summary> Returns information about the DeleteTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.DeleteTableResponse.DeleteTableResult"> <summary> Gets and sets the DeleteTableResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.DeleteTableResult"> <summary>Delete Table Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.DeleteTableResult.WithTableDescription(Amazon.DynamoDB.Model.TableDescription)"> <summary> Sets the TableDescription property </summary> <param name="tableDescription">The value to set for the TableDescription property </param> <returns>this instance</returns> </member> <member name="T:Amazon.DynamoDB.Model.DescribeTableRequest"> <summary> Container for the parameters to the DescribeTable operation. <para>Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.</para> <para>If the table does not exist, Amazon DynamoDB returns a <c>ResourceNotFoundException</c> .</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.DescribeTable(Amazon.DynamoDB.Model.DescribeTableRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.DescribeTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.DescribeTableRequest.TableName"> <summary> The name of the table you want to describe. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.DescribeTableResponse"> <summary> Returns information about the DescribeTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.DescribeTableResponse.DescribeTableResult"> <summary> Gets and sets the DescribeTableResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.DescribeTableResult"> <summary>Describe Table Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.DescribeTableResult.WithTable(Amazon.DynamoDB.Model.TableDescription)"> <summary> Sets the Table property </summary> <param name="table">The value to set for the Table property </param> <returns>this instance</returns> </member> <member name="T:Amazon.DynamoDB.Model.ExpectedAttributeValue"> <summary> <para>Allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.ExpectedAttributeValue.WithValue(Amazon.DynamoDB.Model.AttributeValue)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ExpectedAttributeValue.WithExists(System.Boolean)"> <summary> Sets the Exists property </summary> <param name="exists">The value to set for the Exists property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.ExpectedAttributeValue.Value"> <summary> Specify whether or not a value already exists and has a specific content for the attribute name-value pair. </summary> </member> <member name="P:Amazon.DynamoDB.Model.ExpectedAttributeValue.Exists"> <summary> Specify whether or not a value already exists for the attribute name-value pair. </summary> </member> <member name="T:Amazon.DynamoDB.Model.GetItemRequest"> <summary> Container for the parameters to the GetItem operation. <para>Retrieves a set of Attributes for an item that matches the primary key.</para> <para>The <c>GetItem</c> operation provides an eventually-consistent read by default. If eventually-consistent reads are not acceptable for your application, use <c>ConsistentRead</c> . Although this operation might take longer than a standard read, it always returns the last updated value.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.GetItem(Amazon.DynamoDB.Model.GetItemRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.GetItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.GetItemRequest.WithKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.GetItemRequest.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.GetItemRequest.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.GetItemRequest.WithConsistentRead(System.Boolean)"> <summary> Sets the ConsistentRead property </summary> <param name="consistentRead">The value to set for the ConsistentRead property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.GetItemRequest.TableName"> <summary> The name of the table in which you want to get an item. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.GetItemRequest.Key"> <summary> The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key. </summary> </member> <member name="P:Amazon.DynamoDB.Model.GetItemRequest.AttributesToGet"> <summary> List of <c>Attribute</c> names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.GetItemRequest.ConsistentRead"> <summary> If set to <c>true</c>, then a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDB.Model.GetItemResponse"> <summary> Returns information about the GetItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.GetItemResponse.GetItemResult"> <summary> Gets and sets the GetItemResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.GetItemResult"> <summary>Get Item Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.GetItemResult.WithItem(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Item dictionary. </summary> <param name="pairs">The pairs to be added to the Item dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.GetItemResult.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.GetItemResult.Item"> <summary> Contains the requested attributes. </summary> </member> <member name="P:Amazon.DynamoDB.Model.GetItemResult.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.InternalServerErrorException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDB.Model.InternalServerErrorException.#ctor(System.String)"> <summary> Constructs a new InternalServerErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.AttributeValueUnmarshaller"> <summary> AttributeValueUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchGetItemRequestMarshaller"> <summary> Batch Get Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchGetItemResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetItem operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchGetItemResultUnmarshaller"> <summary> BatchGetItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchResponseUnmarshaller"> <summary> BatchResponseUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchWriteItemRequestMarshaller"> <summary> Batch Write Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchWriteItemResponseUnmarshaller"> <summary> Response Unmarshaller for BatchWriteItem operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchWriteItemResultUnmarshaller"> <summary> BatchWriteItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.BatchWriteResponseUnmarshaller"> <summary> BatchWriteResponseUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.CreateTableRequestMarshaller"> <summary> Create Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.CreateTableResponseUnmarshaller"> <summary> Response Unmarshaller for CreateTable operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.CreateTableResultUnmarshaller"> <summary> CreateTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DeleteItemRequestMarshaller"> <summary> Delete Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DeleteItemResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteItem operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DeleteItemResultUnmarshaller"> <summary> DeleteItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DeleteRequestUnmarshaller"> <summary> DeleteRequestUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DeleteTableRequestMarshaller"> <summary> Delete Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DeleteTableResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteTable operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DeleteTableResultUnmarshaller"> <summary> DeleteTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DescribeTableRequestMarshaller"> <summary> Describe Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DescribeTableResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTable operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.DescribeTableResultUnmarshaller"> <summary> DescribeTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.GetItemRequestMarshaller"> <summary> Get Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.GetItemResponseUnmarshaller"> <summary> Response Unmarshaller for GetItem operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.GetItemResultUnmarshaller"> <summary> GetItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.KeysAndAttributesUnmarshaller"> <summary> KeysAndAttributesUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.KeySchemaElementUnmarshaller"> <summary> KeySchemaElementUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.KeySchemaUnmarshaller"> <summary> KeySchemaUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.KeyUnmarshaller"> <summary> KeyUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.ListTablesRequestMarshaller"> <summary> List Tables Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.ListTablesResponseUnmarshaller"> <summary> Response Unmarshaller for ListTables operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.ListTablesResultUnmarshaller"> <summary> ListTablesResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.ProvisionedThroughputDescriptionUnmarshaller"> <summary> ProvisionedThroughputDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.PutItemRequestMarshaller"> <summary> Put Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.PutItemResponseUnmarshaller"> <summary> Response Unmarshaller for PutItem operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.PutItemResultUnmarshaller"> <summary> PutItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.PutRequestUnmarshaller"> <summary> PutRequestUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.QueryRequestMarshaller"> <summary> Query Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.QueryResponseUnmarshaller"> <summary> Response Unmarshaller for Query operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.QueryResultUnmarshaller"> <summary> QueryResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.ScanRequestMarshaller"> <summary> Scan Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.ScanResponseUnmarshaller"> <summary> Response Unmarshaller for Scan operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.ScanResultUnmarshaller"> <summary> ScanResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.TableDescriptionUnmarshaller"> <summary> TableDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.UpdateItemRequestMarshaller"> <summary> Update Item Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.UpdateItemResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateItem operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.UpdateItemResultUnmarshaller"> <summary> UpdateItemResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.UpdateTableRequestMarshaller"> <summary> Update Table Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.UpdateTableResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateTable operation </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.UpdateTableResultUnmarshaller"> <summary> UpdateTableResultUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Internal.MarshallTransformations.WriteRequestUnmarshaller"> <summary> WriteRequestUnmarshaller </summary> </member> <member name="T:Amazon.DynamoDB.Model.Key"> <summary> <para>The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.Key.WithHashKeyElement(Amazon.DynamoDB.Model.AttributeValue)"> <summary> Sets the HashKeyElement property </summary> <param name="hashKeyElement">The value to set for the HashKeyElement property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.Key.WithRangeKeyElement(Amazon.DynamoDB.Model.AttributeValue)"> <summary> Sets the RangeKeyElement property </summary> <param name="rangeKeyElement">The value to set for the RangeKeyElement property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.Key.HashKeyElement"> <summary> A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be <c>String</c>, <c>Number</c>, <c>StringSet</c>, <c>NumberSet</c>. </summary> </member> <member name="P:Amazon.DynamoDB.Model.Key.RangeKeyElement"> <summary> A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be <c>String</c>, <c>Number</c>, <c>StringSet</c>, <c>NumberSet</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.KeysAndAttributes"> <summary>Keys And Attributes </summary> </member> <member name="M:Amazon.DynamoDB.Model.KeysAndAttributes.WithKeys(Amazon.DynamoDB.Model.Key[])"> <summary> Adds elements to the Keys collection </summary> <param name="keys">The values to add to the Keys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.KeysAndAttributes.WithKeys(System.Collections.Generic.IEnumerable{Amazon.DynamoDB.Model.Key})"> <summary> Adds elements to the Keys collection </summary> <param name="keys">The values to add to the Keys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.KeysAndAttributes.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.KeysAndAttributes.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.KeysAndAttributes.WithConsistentRead(System.Boolean)"> <summary> Sets the ConsistentRead property </summary> <param name="consistentRead">The value to set for the ConsistentRead property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.KeysAndAttributes.AttributesToGet"> <summary> List of <c>Attribute</c> names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.KeysAndAttributes.ConsistentRead"> <summary> If set to <c>true</c>, then a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDB.Model.KeySchema"> <summary> <para>The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a <c>HashKeyElement</c> . A composite hash-and-range primary key contains two attribute values: a <c>HashKeyElement</c> and a <c>RangeKeyElement</c> .</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.KeySchema.WithHashKeyElement(Amazon.DynamoDB.Model.KeySchemaElement)"> <summary> Sets the HashKeyElement property </summary> <param name="hashKeyElement">The value to set for the HashKeyElement property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.KeySchema.WithRangeKeyElement(Amazon.DynamoDB.Model.KeySchemaElement)"> <summary> Sets the RangeKeyElement property </summary> <param name="rangeKeyElement">The value to set for the RangeKeyElement property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.KeySchema.HashKeyElement"> <summary> A hash key element is treated as the primary key, and can be a string or a number. Single attribute primary keys have one index value. The value can be <c>String</c>, <c>Number</c>, <c>StringSet</c>, <c>NumberSet</c>. </summary> </member> <member name="P:Amazon.DynamoDB.Model.KeySchema.RangeKeyElement"> <summary> A range key element is treated as a secondary key (used in conjunction with the primary key), and can be a string or a number, and is only used for hash-and-range primary keys. The value can be <c>String</c>, <c>Number</c>, <c>StringSet</c>, <c>NumberSet</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.KeySchemaElement"> <summary> <para> <c>KeySchemaElement</c> is the primary key (hash or hash-and-range) structure for the table.</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.KeySchemaElement.WithAttributeName(System.String)"> <summary> Sets the AttributeName property </summary> <param name="attributeName">The value to set for the AttributeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.KeySchemaElement.WithAttributeType(System.String)"> <summary> Sets the AttributeType property </summary> <param name="attributeType">The value to set for the AttributeType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.KeySchemaElement.AttributeName"> <summary> The <c>AttributeName</c> of the <c>KeySchemaElement</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - 255</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.KeySchemaElement.AttributeType"> <summary> The <c>AttributeType</c> of the <c>KeySchemaElement</c> which can be a <c>String</c> or a <c>Number</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>S, N, B</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.LimitExceededException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDB.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDB.Model.ListTablesRequest"> <summary> Container for the parameters to the ListTables operation. <para>Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. <c>us-east-1</c> ).</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.ListTables(Amazon.DynamoDB.Model.ListTablesRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.ListTablesRequest.WithExclusiveStartTableName(System.String)"> <summary> Sets the ExclusiveStartTableName property </summary> <param name="exclusiveStartTableName">The value to set for the ExclusiveStartTableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ListTablesRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.ListTablesRequest.ExclusiveStartTableName"> <summary> The name of the table that starts the list. If you already ran a <c>ListTables</c> operation and received a <c>LastEvaluatedTableName</c> value in the response, use that value here to continue the list. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.ListTablesRequest.Limit"> <summary> A number of maximum table names to return. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 100</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.ListTablesResponse"> <summary> Returns information about the ListTablesResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.ListTablesResponse.ListTablesResult"> <summary> Gets and sets the ListTablesResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.ListTablesResult"> <summary>List Tables Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.ListTablesResult.WithTableNames(System.String[])"> <summary> Adds elements to the TableNames collection </summary> <param name="tableNames">The values to add to the TableNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ListTablesResult.WithTableNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the TableNames collection </summary> <param name="tableNames">The values to add to the TableNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ListTablesResult.WithLastEvaluatedTableName(System.String)"> <summary> Sets the LastEvaluatedTableName property </summary> <param name="lastEvaluatedTableName">The value to set for the LastEvaluatedTableName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.ListTablesResult.LastEvaluatedTableName"> <summary> The name of the last table in the current list. Use this value as the <c>ExclusiveStartTableName</c> in a new request to continue the list until all the table names are returned. If this value is null, all table names have been returned. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.ProvisionedThroughput"> <summary> <para>Provisioned throughput reserves the required read and write resources for your table in terms of <c>ReadCapacityUnits</c> and <c>WriteCapacityUnits</c> . Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads.</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughput.WithReadCapacityUnits(System.Int64)"> <summary> Sets the ReadCapacityUnits property </summary> <param name="readCapacityUnits">The value to set for the ReadCapacityUnits property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughput.WithWriteCapacityUnits(System.Int64)"> <summary> Sets the WriteCapacityUnits property </summary> <param name="writeCapacityUnits">The value to set for the WriteCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.ProvisionedThroughput.ReadCapacityUnits"> <summary> <c>ReadCapacityUnits</c> are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the <c>ReadCapacityUnits</c>. Eventually-consistent reads only require half the <c>ReadCapacityUnits</c> of stirctly consistent reads. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.ProvisionedThroughput.WriteCapacityUnits"> <summary> <c>WriteCapacityUnits</c> are in terms of strictly consistent reads, assuming items of 1k. 2k items require twice the <c>WriteCapacityUnits</c>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.ProvisionedThroughputDescription"> <summary>Provisioned Throughput Description </summary> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughputDescription.WithLastIncreaseDateTime(System.DateTime)"> <summary> Sets the LastIncreaseDateTime property </summary> <param name="lastIncreaseDateTime">The value to set for the LastIncreaseDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughputDescription.WithLastDecreaseDateTime(System.DateTime)"> <summary> Sets the LastDecreaseDateTime property </summary> <param name="lastDecreaseDateTime">The value to set for the LastDecreaseDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughputDescription.WithNumberOfDecreasesToday(System.Int64)"> <summary> Sets the NumberOfDecreasesToday property </summary> <param name="numberOfDecreasesToday">The value to set for the NumberOfDecreasesToday property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughputDescription.WithReadCapacityUnits(System.Int64)"> <summary> Sets the ReadCapacityUnits property </summary> <param name="readCapacityUnits">The value to set for the ReadCapacityUnits property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughputDescription.WithWriteCapacityUnits(System.Int64)"> <summary> Sets the WriteCapacityUnits property </summary> <param name="writeCapacityUnits">The value to set for the WriteCapacityUnits property </param> <returns>this instance</returns> </member> <member name="T:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDB.Model.ProvisionedThroughputExceededException.#ctor(System.String)"> <summary> Constructs a new ProvisionedThroughputExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDB.Model.PutItemRequest"> <summary> Container for the parameters to the PutItem operation. <para>Creates a new item, or replaces an old item with a new item (including all the attributes).</para> <para>If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert 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> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.PutItem(Amazon.DynamoDB.Model.PutItemRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.PutItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.PutItemRequest.WithItem(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Item dictionary. </summary> <param name="pairs">The pairs to be added to the Item dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.PutItemRequest.WithExpected(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.ExpectedAttributeValue}[])"> <summary> Adds the KeyValuePairs to the Expected dictionary. </summary> <param name="pairs">The pairs to be added to the Expected dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.PutItemRequest.WithReturnValues(System.String)"> <summary> Sets the ReturnValues property </summary> <param name="returnValues">The value to set for the ReturnValues property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.PutItemRequest.TableName"> <summary> The name of the table in which you want to put an item. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.PutItemRequest.Item"> <summary> A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item. </summary> </member> <member name="P:Amazon.DynamoDB.Model.PutItemRequest.Expected"> <summary> Designates an attribute for a conditional modification. The <c>Expected</c> parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it. </summary> </member> <member name="P:Amazon.DynamoDB.Model.PutItemRequest.ReturnValues"> <summary> Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For <c>PUT</c> operations, the possible parameter values are <c>NONE</c> (default) or <c>ALL_OLD</c>. For update operations, the possible parameter values are <c>NONE</c> (default) or <c>ALL_OLD</c>, <c>UPDATED_OLD</c>, <c>ALL_NEW</c> or <c>UPDATED_NEW</c>. <ul> <li><c>NONE</c>: Nothing is returned.</li> <li><c>ALL_OLD</c>: Returns the attributes of the item as they were before the operation.</li> <li><c>UPDATED_OLD</c>: Returns the values of the updated attributes, only, as they were before the operation.</li> <li><c>ALL_NEW</c>: Returns all the attributes and their new values after the operation.</li> <li><c>UPDATED_NEW</c>: Returns the values of the updated attributes, only, as they are after the operation.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.PutItemResponse"> <summary> Returns information about the PutItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.PutItemResponse.PutItemResult"> <summary> Gets and sets the PutItemResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.PutItemResult"> <summary>Put Item Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.PutItemResult.WithAttributes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Attributes dictionary. </summary> <param name="pairs">The pairs to be added to the Attributes dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.PutItemResult.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.PutItemResult.Attributes"> <summary> Attribute values before the put operation, but only if the <c>ReturnValues</c> parameter is specified as <c>ALL_OLD</c> in the request. </summary> </member> <member name="P:Amazon.DynamoDB.Model.PutItemResult.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.PutRequest"> <summary> <para>A container for a Put BatchWrite request</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.PutRequest.WithItem(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Item dictionary. </summary> <param name="pairs">The pairs to be added to the Item dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.PutRequest.Item"> <summary> The item to put </summary> </member> <member name="T:Amazon.DynamoDB.Model.QueryRequest"> <summary> Container for the parameters to the Query operation. <para>Gets the values of one or more items and its attributes by primary key (composite primary key, only).</para> <para>Narrow the scope of the query using comparison operators on the <c>RangeKeyValue</c> of the composite key. Use the <c>ScanIndexForward</c> parameter to get results in forward or reverse order by range key.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Query(Amazon.DynamoDB.Model.QueryRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithConsistentRead(System.Boolean)"> <summary> Sets the ConsistentRead property </summary> <param name="consistentRead">The value to set for the ConsistentRead property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithCount(System.Boolean)"> <summary> Sets the Count property </summary> <param name="count">The value to set for the Count property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithHashKeyValue(Amazon.DynamoDB.Model.AttributeValue)"> <summary> Sets the HashKeyValue property </summary> <param name="hashKeyValue">The value to set for the HashKeyValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithRangeKeyCondition(Amazon.DynamoDB.Model.Condition)"> <summary> Sets the RangeKeyCondition property </summary> <param name="rangeKeyCondition">The value to set for the RangeKeyCondition property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithScanIndexForward(System.Boolean)"> <summary> Sets the ScanIndexForward property </summary> <param name="scanIndexForward">The value to set for the ScanIndexForward property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryRequest.WithExclusiveStartKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the ExclusiveStartKey property </summary> <param name="exclusiveStartKey">The value to set for the ExclusiveStartKey property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.TableName"> <summary> The name of the table in which you want to query. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.AttributesToGet"> <summary> List of <c>Attribute</c> names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.Limit"> <summary> The maximum number of items to return. If Amazon DynamoDB hits this limit while querying the table, it stops the query and returns the matching values up to the limit, and a <c>LastEvaluatedKey</c> to apply in a subsequent operation to continue the query. Also, if the result set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops the query and returns the matching values, and a <c>LastEvaluatedKey</c> to apply in a subsequent operation to continue the query. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.ConsistentRead"> <summary> If set to <c>true</c>, then a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.Count"> <summary> If set to <c>true</c>, Amazon DynamoDB returns a total number of items that match the query parameters, instead of a list of the matching items and their attributes. Do not set <c>Count</c> to <c>true</c> while providing a list of <c>AttributesToGet</c>, otherwise Amazon DynamoDB returns a validation error. </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.HashKeyValue"> <summary> Attribute value of the hash component of the composite primary key. </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.RangeKeyCondition"> <summary> A container for the attribute values and comparison operators to use for the query. </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.ScanIndexForward"> <summary> Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested order, determined by the range key. The default value is <c>true</c> (forward). </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryRequest.ExclusiveStartKey"> <summary> Primary key of the item from which to continue an earlier query. An earlier query might provide this value as the <c>LastEvaluatedKey</c> if that query operation was interrupted before completing the query; either because of the result set size or the <c>Limit</c> parameter. The <c>LastEvaluatedKey</c> can be passed back in a new query request to continue the operation from that point. </summary> </member> <member name="T:Amazon.DynamoDB.Model.QueryResponse"> <summary> Returns information about the QueryResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryResponse.QueryResult"> <summary> Gets and sets the QueryResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.QueryResult"> <summary>Query Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.QueryResult.WithItems(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryResult.WithItems(System.Collections.Generic.IEnumerable{System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.AttributeValue}})"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryResult.WithCount(System.Int32)"> <summary> Sets the Count property </summary> <param name="count">The value to set for the Count property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryResult.WithLastEvaluatedKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the LastEvaluatedKey property </summary> <param name="lastEvaluatedKey">The value to set for the LastEvaluatedKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.QueryResult.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.QueryResult.Count"> <summary> Number of items in the response. </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryResult.LastEvaluatedKey"> <summary> Primary key of the item where the query operation stopped, inclusive of the previous result set. Use this value to start a new operation excluding this value in the new request. The <c>LastEvaluatedKey</c> is null when the entire query result set is complete (i.e. the operation processed the "last page"). </summary> </member> <member name="P:Amazon.DynamoDB.Model.QueryResult.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.ResourceInUseException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDB.Model.ResourceInUseException.#ctor(System.String)"> <summary> Constructs a new ResourceInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDB.Model.ResourceNotFoundException"> <summary> AmazonDynamoDB exception </summary> </member> <member name="M:Amazon.DynamoDB.Model.ResourceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ResourceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDB.Model.ScanRequest"> <summary> Container for the parameters to the Scan operation. <para>Retrieves one or more items and its attributes by performing a full scan of a table.</para> <para>Provide a <c>ScanFilter</c> to get more specific results.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.Scan(Amazon.DynamoDB.Model.ScanRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.ScanRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanRequest.WithAttributesToGet(System.String[])"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanRequest.WithAttributesToGet(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AttributesToGet collection </summary> <param name="attributesToGet">The values to add to the AttributesToGet collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanRequest.WithCount(System.Boolean)"> <summary> Sets the Count property </summary> <param name="count">The value to set for the Count property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanRequest.WithScanFilter(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.Condition}[])"> <summary> Adds the KeyValuePairs to the ScanFilter dictionary. </summary> <param name="pairs">The pairs to be added to the ScanFilter dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanRequest.WithExclusiveStartKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the ExclusiveStartKey property </summary> <param name="exclusiveStartKey">The value to set for the ExclusiveStartKey property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.ScanRequest.TableName"> <summary> The name of the table in which you want to scan. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanRequest.AttributesToGet"> <summary> List of <c>Attribute</c> names. If attribute names are not specified then all attributes will be returned. If some attributes are not found, they will not appear in the result. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanRequest.Limit"> <summary> The maximum number of items to return. If Amazon DynamoDB hits this limit while scanning the table, it stops the scan and returns the matching values up to the limit, and a <c>LastEvaluatedKey</c> to apply in a subsequent operation to continue the scan. Also, if the scanned data set size exceeds 1 MB before Amazon DynamoDB hits this limit, it stops the scan and returns the matching values up to the limit, and a <c>LastEvaluatedKey</c> to apply in a subsequent operation to continue the scan. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - </description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanRequest.Count"> <summary> If set to <c>true</c>, Amazon DynamoDB returns a total number of items for the <c>Scan</c> operation, even if the operation has no matching items for the assigned filter. Do not set <c>Count</c> to <c>true</c> while providing a list of <c>AttributesToGet</c>, otherwise Amazon DynamoDB returns a validation error. </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanRequest.ScanFilter"> <summary> Evaluates the scan results and returns only the desired values. </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanRequest.ExclusiveStartKey"> <summary> Primary key of the item from which to continue an earlier scan. An earlier scan might provide this value if that scan operation was interrupted before scanning the entire table; either because of the result set size or the <c>Limit</c> parameter. The <c>LastEvaluatedKey</c> can be passed back in a new scan request to continue the operation from that point. </summary> </member> <member name="T:Amazon.DynamoDB.Model.ScanResponse"> <summary> Returns information about the ScanResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanResponse.ScanResult"> <summary> Gets and sets the ScanResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.ScanResult"> <summary>Scan Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.ScanResult.WithItems(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanResult.WithItems(System.Collections.Generic.IEnumerable{System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDB.Model.AttributeValue}})"> <summary> Adds elements to the Items collection </summary> <param name="items">The values to add to the Items collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanResult.WithCount(System.Int32)"> <summary> Sets the Count property </summary> <param name="count">The value to set for the Count property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanResult.WithScannedCount(System.Int32)"> <summary> Sets the ScannedCount property </summary> <param name="scannedCount">The value to set for the ScannedCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanResult.WithLastEvaluatedKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the LastEvaluatedKey property </summary> <param name="lastEvaluatedKey">The value to set for the LastEvaluatedKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.ScanResult.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.ScanResult.Count"> <summary> Number of items in the response. </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanResult.ScannedCount"> <summary> Number of items in the complete scan before any filters are applied. A high <c>ScannedCount</c> value with few, or no, <c>Count</c> results indicates an inefficient <c>Scan</c> operation. </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanResult.LastEvaluatedKey"> <summary> Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The <c>LastEvaluatedKey</c> is null when the entire scan result set is complete (i.e. the operation processed the "last page"). </summary> </member> <member name="P:Amazon.DynamoDB.Model.ScanResult.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.TableDescription"> <summary>Table Description </summary> </member> <member name="M:Amazon.DynamoDB.Model.TableDescription.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.TableDescription.WithKeySchema(Amazon.DynamoDB.Model.KeySchema)"> <summary> Sets the KeySchema property </summary> <param name="keySchema">The value to set for the KeySchema property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.TableDescription.WithTableStatus(System.String)"> <summary> Sets the TableStatus property </summary> <param name="tableStatus">The value to set for the TableStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.TableDescription.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.TableDescription.WithProvisionedThroughput(Amazon.DynamoDB.Model.ProvisionedThroughputDescription)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.TableDescription.WithTableSizeBytes(System.Int64)"> <summary> Sets the TableSizeBytes property </summary> <param name="tableSizeBytes">The value to set for the TableSizeBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.TableDescription.WithItemCount(System.Int64)"> <summary> Sets the ItemCount property </summary> <param name="itemCount">The value to set for the ItemCount property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.TableDescription.TableName"> <summary> The name of the table being described. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.TableDescription.KeySchema"> <summary> The KeySchema identifies the primary key as a one attribute primary key (hash) or a composite two attribute (hash-and-range) primary key. Single attribute primary keys have one index value: a <c>HashKeyElement</c>. A composite hash-and-range primary key contains two attribute values: a <c>HashKeyElement</c> and a <c>RangeKeyElement</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.UpdateItemRequest"> <summary> Container for the parameters to the UpdateItem operation. <para>Edits an existing item's attributes.</para> <para>You can perform a conditional update (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> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateItem(Amazon.DynamoDB.Model.UpdateItemRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.UpdateItemRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.UpdateItemRequest.WithKey(Amazon.DynamoDB.Model.Key)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.UpdateItemRequest.WithAttributeUpdates(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.AttributeValueUpdate}[])"> <summary> Adds the KeyValuePairs to the AttributeUpdates dictionary. </summary> <param name="pairs">The pairs to be added to the AttributeUpdates dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.UpdateItemRequest.WithExpected(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.ExpectedAttributeValue}[])"> <summary> Adds the KeyValuePairs to the Expected dictionary. </summary> <param name="pairs">The pairs to be added to the Expected dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.UpdateItemRequest.WithReturnValues(System.String)"> <summary> Sets the ReturnValues property </summary> <param name="returnValues">The value to set for the ReturnValues property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemRequest.TableName"> <summary> The name of the table in which you want to update an item. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemRequest.Key"> <summary> The primary key that uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key. </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemRequest.AttributeUpdates"> <summary> Map of attribute name to the new value and action for the update. The attribute names specify the attributes to modify, and cannot contain any primary key attributes. </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemRequest.Expected"> <summary> Designates an attribute for a conditional modification. The <c>Expected</c> parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it. </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemRequest.ReturnValues"> <summary> Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For <c>PUT</c> operations, the possible parameter values are <c>NONE</c> (default) or <c>ALL_OLD</c>. For update operations, the possible parameter values are <c>NONE</c> (default) or <c>ALL_OLD</c>, <c>UPDATED_OLD</c>, <c>ALL_NEW</c> or <c>UPDATED_NEW</c>. <ul> <li><c>NONE</c>: Nothing is returned.</li> <li><c>ALL_OLD</c>: Returns the attributes of the item as they were before the operation.</li> <li><c>UPDATED_OLD</c>: Returns the values of the updated attributes, only, as they were before the operation.</li> <li><c>ALL_NEW</c>: Returns all the attributes and their new values after the operation.</li> <li><c>UPDATED_NEW</c>: Returns the values of the updated attributes, only, as they are after the operation.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.DynamoDB.Model.UpdateItemResponse"> <summary> Returns information about the UpdateItemResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemResponse.UpdateItemResult"> <summary> Gets and sets the UpdateItemResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.UpdateItemResult"> <summary>Update Item Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.UpdateItemResult.WithAttributes(System.Collections.Generic.KeyValuePair{System.String,Amazon.DynamoDB.Model.AttributeValue}[])"> <summary> Adds the KeyValuePairs to the Attributes dictionary. </summary> <param name="pairs">The pairs to be added to the Attributes dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.UpdateItemResult.WithConsumedCapacityUnits(System.Double)"> <summary> Sets the ConsumedCapacityUnits property </summary> <param name="consumedCapacityUnits">The value to set for the ConsumedCapacityUnits property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemResult.Attributes"> <summary> A map of attribute name-value pairs, but only if the <c>ReturnValues</c> parameter is specified as something other than <c>NONE</c> in the request. </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateItemResult.ConsumedCapacityUnits"> <summary> The number of Capacity Units of the provisioned throughput of the table consumed during the operation. <c>GetItem</c>, <c>BatchGetItem</c>, <c>BatchWriteItem</c>, <c>Query</c>, and <c>Scan</c> operations consume <c>ReadCapacityUnits</c>, while <c>PutItem</c>, <c>UpdateItem</c>, and <c>DeleteItem</c> operations consume <c>WriteCapacityUnits</c>. </summary> </member> <member name="T:Amazon.DynamoDB.Model.UpdateTableRequest"> <summary> Container for the parameters to the UpdateTable operation. <para>Updates the provisioned throughput for the given table.</para> <para>Setting the throughput for a table helps you manage performance and is part of the Provisioned Throughput feature of Amazon DynamoDB.</para> </summary> <seealso cref="M:Amazon.DynamoDB.AmazonDynamoDB.UpdateTable(Amazon.DynamoDB.Model.UpdateTableRequest)"/> </member> <member name="M:Amazon.DynamoDB.Model.UpdateTableRequest.WithTableName(System.String)"> <summary> Sets the TableName property </summary> <param name="tableName">The value to set for the TableName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.UpdateTableRequest.WithProvisionedThroughput(Amazon.DynamoDB.Model.ProvisionedThroughput)"> <summary> Sets the ProvisionedThroughput property </summary> <param name="provisionedThroughput">The value to set for the ProvisionedThroughput property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.UpdateTableRequest.TableName"> <summary> The name of the table you want to update. Allowed characters are <c>a-z</c>, <c>A-Z</c>, <c>0-9</c>, <c>_</c> (underscore), <c>-</c> (hyphen) and <c>.</c> (period). <para> <b>Constraints:</b> <list type="definition"> <item> <term>Length</term> <description>3 - 255</description> </item> <item> <term>Pattern</term> <description>[a-zA-Z0-9_.-]+</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateTableRequest.ProvisionedThroughput"> <summary> Provisioned throughput reserves the required read and write resources for your table in terms of <c>ReadCapacityUnits</c> and <c>WriteCapacityUnits</c>. Values for provisioned throughput depend upon your expected read/write rates, item size, and consistency. Provide the expected number of read and write operations, assuming an item size of 1k and strictly consistent reads. For 2k item size, double the value. For 3k, triple the value, etc. Eventually-consistent reads consume half the resources of strictly consistent reads. </summary> </member> <member name="T:Amazon.DynamoDB.Model.UpdateTableResponse"> <summary> Returns information about the UpdateTableResult response and response metadata. </summary> </member> <member name="P:Amazon.DynamoDB.Model.UpdateTableResponse.UpdateTableResult"> <summary> Gets and sets the UpdateTableResult property. </summary> </member> <member name="T:Amazon.DynamoDB.Model.UpdateTableResult"> <summary>Update Table Result </summary> </member> <member name="M:Amazon.DynamoDB.Model.UpdateTableResult.WithTableDescription(Amazon.DynamoDB.Model.TableDescription)"> <summary> Sets the TableDescription property </summary> <param name="tableDescription">The value to set for the TableDescription property </param> <returns>this instance</returns> </member> <member name="T:Amazon.DynamoDB.Model.WriteRequest"> <summary> <para>This structure is a Union of PutRequest and DeleteRequest. It can contain exactly one of <c>PutRequest</c> or <c>DeleteRequest</c> . Never Both. This is enforced in the code.</para> </summary> </member> <member name="M:Amazon.DynamoDB.Model.WriteRequest.WithPutRequest(Amazon.DynamoDB.Model.PutRequest)"> <summary> Sets the PutRequest property </summary> <param name="putRequest">The value to set for the PutRequest property </param> <returns>this instance</returns> </member> <member name="M:Amazon.DynamoDB.Model.WriteRequest.WithDeleteRequest(Amazon.DynamoDB.Model.DeleteRequest)"> <summary> Sets the DeleteRequest property </summary> <param name="deleteRequest">The value to set for the DeleteRequest property </param> <returns>this instance</returns> </member> <member name="P:Amazon.DynamoDB.Model.WriteRequest.PutRequest"> <summary> A container for a Put BatchWrite request </summary> </member> <member name="P:Amazon.DynamoDB.Model.WriteRequest.DeleteRequest"> <summary> A container for a Delete BatchWrite request </summary> </member> <member name="T:Amazon.EC2.AmazonEC2"> <summary> The Amazon Elastic Compute Cloud (Amazon EC2) web service provides you with the ability to execute your applications in Amazon's computing environment. To use Amazon EC2 you simply: 1. Create an Amazon Machine Image (AMI) containing all your software, including your operating system and associated configuration settings, applications, libraries, etc. Think of this as zipping up the contents of your hard drive. We provide all the necessary tools to create and package your AMI. 2. Upload this AMI to the Amazon S3 (Amazon Simple Storage Service) service. This gives us reliable, secure access to your AMI. 3. Register your AMI with Amazon EC2. This allows us to verify that your AMI has been uploaded correctly and to allocate a unique identifier for it. 4. Use this AMI ID and the Amazon EC2 web service APIs to run, monitor, and terminate as many instances of this AMI as required. You can also skip the first three steps and choose to launch an AMI that is provided by Amazon or shared by another user. While instances are running, you are billed for the computing and network resources that they consume. You can also skip the first three steps and choose to launch an AMI that is provided by Amazon or shared by another user. While instances are running, you are billed for the computing and network resources that they consume. </summary> </member> <member name="M:Amazon.EC2.AmazonEC2.DryRun(Amazon.EC2.Model.EC2Request)"> <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="M:Amazon.EC2.AmazonEC2.ActivateLicense(Amazon.EC2.Model.ActivateLicenseRequest)"> <summary> Activates a license. </summary> <remarks> Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID. </remarks> <param name="request">Activate License request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Activate License Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AllocateAddress(Amazon.EC2.Model.AllocateAddressRequest)"> <summary> Acquires an elastic IP address for use with your account or your VPC. </summary> <param name="request">Allocate Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Allocate Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AssociateAddress(Amazon.EC2.Model.AssociateAddressRequest)"> <summary> Associates an elastic IP address with an instance. If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. </summary> <remarks> This is an idempotent operation. If you call it more than once, Amazon EC2 does not return an error. </remarks> <param name="request">Associate Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Associate Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AttachVolume(Amazon.EC2.Model.AttachVolumeRequest)"> <summary> <para>Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.</para> <para>Encrypted Amazon 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 Amazon EBS Volume to an Instance</a> . Any device names that aren't reserved for instance store volumes can be used for Amazon 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 only be attached as the root device of a stopped instance.</li> <li>You must be subscribed to the AWS Marketplace code that is on the volume.</li> <li>The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> </ul> <para>For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000" >https://aws.amazon.com/marketplace/help/200900000</a> . For more information about how to use the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace" >AWS Marketplace</a> .</para> <para>For more information about Amazon 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">Attach Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest)"> <summary> Adds one or more ingress rules to a security group. This action applies to both EC2 security groups and VPC security groups. </summary> <remarks> Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields. Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur. When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission, GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified </remarks> <param name="request">Authorize Security Group Ingress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Authorize Security Group Ingress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.BundleInstance(Amazon.EC2.Model.BundleInstanceRequest)"> <summary> Bundles an Amazon instance store-backed Windows instance. This procedure is not applicable for Linux and UNIX instances. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </summary> <param name="request">Bundle Instance request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Bundle Instance Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest)"> <summary> Cancels a bundling operation for an instance store-backed Windows instance. </summary> <param name="request">Cancel Bundle Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Bundle Task Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest)"> <summary> Determines whether a product code is associated with an instance. </summary> <remarks> 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 EC2 user’s instance is eligible for support. </remarks> <param name="request">Confirm Product Instance request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Confirm Product Instance Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateImage(Amazon.EC2.Model.CreateImageRequest)"> <summary> Creates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started. </summary> <param name="request">Create Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Image Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest)"> <summary> Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is returned to you. </summary> <remarks> 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. The key pair returned to you works only in the Region you're using when you create the key pair. To create a key pair that works in all Regions, use ImportKeyPair. </remarks> <param name="request">Create Key Pair request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Key Pair Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest)"> <summary> Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched. Users must give the group a name unique within the scope of the user account. </summary> <param name="request">Create Placement Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Placement Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest)"> <summary> Creates a new security group. Group names must be unique per account. </summary> <remarks> Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations. </remarks> <param name="request">Create Security Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Security Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest)"> <summary> <para>Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.</para> <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 Amazon 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 writes to 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 <c>pending</c> .</para> <para>To create a snapshot for Amazon 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">Create Snapshot request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Snapshot Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateTags(Amazon.EC2.Model.CreateTagsRequest)"> <summary> Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags. Each tag consists of a key-value pair. Tag keys must be unique per resource. </summary> <param name="request">Create Tags request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Tags Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateVolume(Amazon.EC2.Model.CreateVolumeRequest)"> <summary> <para>Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the specified region.</para> <para>You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.</para> <para>You can create encrypted volumes with the <c>Encrypted</c> 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">Create Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeactivateLicense(Amazon.EC2.Model.DeactivateLicenseRequest)"> <summary> Deactivates a specific number of licenses. </summary> <remarks> Deactivations can be done against a specific license ID after they have persisted for at least a 90-day period. </remarks> <param name="request">Deactivate License request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Deactivate License Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest)"> <summary> Deletes the specified key pair, by removing the public key from Amazon EC2. You must own the key pair. </summary> <param name="request">Delete Key Pair request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Key Pair Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest)"> <summary> Deletes a PlacementGroupfrom a user's account. Terminate all Amazon EC2 instances in the placement group before deletion. </summary> <param name="request">Delete Placement Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Placement Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest)"> <summary> Deletes a security group that you own. </summary> <remarks> If you attempt to delete a security group that contains instances, an error is returned. If you attempt to delete a security group that is referenced by another security group, an error is returned. For example, if security group B has a rule that allows access from security group A, security group A cannot be deleted until the allow rule is removed. </remarks> <param name="request">Delete Security Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Security Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest)"> <summary> Deletes a snapshot of an Amazon EBS volume that you own. </summary> <param name="request">Delete Snapshot request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Snapshot Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteTags(Amazon.EC2.Model.DeleteTagsRequest)"> <summary> Deletes tags from the specified resources. </summary> <param name="request">Delete Tags request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Tags Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest)"> <summary> <para>Deletes the specified Amazon EBS volume. The volume must be in the <c>available</c> state (not attached to an instance).</para> <para><b>NOTE:</b> The volume may remain in the deleting state for several minutes. </para> <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">Delete Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeregisterImage(Amazon.EC2.Model.DeregisterImageRequest)"> <summary> Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. </summary> <remarks> This command does not delete the AMI from Amazon S3. </remarks> <param name="request">Deregister Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Deregister Image Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest)"> <summary> Lists elastic IP addresses assigned to your account or provides information about a specific address. </summary> <param name="request">Describe Addresses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Addresses Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest)"> <summary> Lists Availability Zones that are currently available to the account and their states. </summary> <remarks> Availability Zones are not the same across accounts. The Availability Zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account. </remarks> <param name="request">Describe Availability Zones request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Availability Zones Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest)"> <summary> Describes current bundling tasks. </summary> <remarks> Describes in-progress and recent bundle tasks. Complete and failed tasks are removed from the list a short time after completion. If no bundle ids are given, all bundle tasks are returned. </remarks> <param name="request">Describe Bundle Tasks request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Bundle Tasks Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeLicenses(Amazon.EC2.Model.DescribeLicensesRequest)"> <summary> Provides details of a user's registered licenses. </summary> <remarks> Zero or more IDs may be specified on the call. When one or more license IDs are specified, only data for the specified IDs are returned. </remarks> <param name="request">Describe Licenses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Licenses Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest)"> <summary> Returns information about one or more PlacementGroup instances in a user's account. </summary> <param name="request">Describe Placement Groups request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Placement Groups Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest)"> <summary> Returns information about an attribute of a snapshot. Only one attribute can be specified per call. </summary> <param name="request">Describe Snapshot Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Snapshot Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest)"> <summary> Gets information about an attribute of an AMI. Only one attribute can be specified per call. </summary> <param name="request">Describe Image Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Image Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeImages(Amazon.EC2.Model.DescribeImagesRequest)"> <summary> Returns information about AMIs, AKIs, and ARIs. This includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to you include public images, private images that you own, and private images owned by other users for which you have explicit launch permissions. </summary> <remarks> Launch permissions fall into three categories: 1. public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs. 2. explicit: The owner of the AMI granted launch permissions to a specific user. 3. implicit: A user has implicit launch permissions for all AMIs he or she owns. The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions. If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results. If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own. If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs. </remarks> <param name="request">Describe Images request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Images Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest)"> <summary> <para>Describes the status of one or more instances, including any scheduled events.</para> <para>Instance status has two main components:</para> <ul> <li> <para>System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.</para> </li> <li> <para>Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.</para> </li> </ul> <para>Instance status provides information about four types of scheduled events for an instance that may require your attention:</para> <ul> <li> <para>Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: <c>system-reboot</c> or <c>instance-reboot</c> . System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.</para> </li> <li> <para>System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code <c>system-maintenance</c> . System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.</para> </li> <li> <para>Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code <c>instance-retirement</c> . Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.</para> </li> <li> <para>Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called <c>instance-stop</c> . Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.</para> </li> </ul> <para>When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is <c>instance-retirement</c> . This ensures that your instance is started on a different underlying host.</para> <para>For more information about failed status checks, see <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> . For more information about working with scheduled events, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#schedevents_actions" >Working with an Instance That Has a Scheduled Event</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> </summary> <param name="request">Describe Instance Status request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Instance Status response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest)"> <summary> Submits feedback about an instance's status. </summary> <remarks> This action works only for instances that are in the running state. If your experience with the instance differs from the instance status returned by the DescribeInstanceStatus action, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. </remarks> <param name="request">Report Instance Status request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Report Instance Status response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest)"> <summary> Returns information about instances that you own. </summary> <remarks> 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 invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results. Recently terminated instances might appear in the returned results.This interval is usually less than one hour. </remarks> <param name="request">Describe Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest)"> <summary> Describes regions that are currently available to the account. </summary> <param name="request">Describe Regions request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Regions Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest)"> <summary> Describes Reserved Instances that you purchased. </summary> <remarks> For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Describe Reserved Instances request</param> <returns>Describe Reserved Instances Response from the service</returns> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest)"> <summary> Describes Reserved Instance offerings that are available for purchase. </summary> <remarks> With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Describe Reserved Instances Offerings request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Reserved Instances Offerings Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest)"> <summary> Returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned. </summary> <param name="request">Describe Key Pairs request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Key Pairs Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest)"> <summary> Returns information about security groups that you own. </summary> <remarks> If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned. </remarks> <param name="request">Describe Security Groups request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Security Groups Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest)"> <summary> Returns information about Amazon EBS snapshots available to the user. </summary> <remarks> Information returned includes volume ID, status, start time, progress, owner ID, volume size, and description. Snapshots available to the user include public snapshots available for any user to launch, private snapshots owned by the user making the request, and private snapshots owned by other users for which the user granted explicit create volume permissions. The create volume permissions fall into 3 categories: public The owner of the snapshot granted create volume permissions for the snapshot to the all group. All users have create volume permissions for these snapshots. explicit The owner of the snapshot granted create volume permissions to a specific user. implicit A user has implicit create volume permissions for all snapshots he or she owns. The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or users with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which the user has create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, a fault is returned. If you specify a snapshot ID for which you do not have access, it will not be included in the returned results. 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, amazon for snapshots owned by Amazon or self for snapshots that you own. If you specify a list of restorable users, only users that have create snapshot permissions for the snapshots are returned. You can specify AWS Account IDs (if you own the snapshot(s)), self for snapshots for which you own or have explicit permissions, or all for public snapshots. </remarks> <param name="request">Describe Snapshots request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Snapshots Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeTags(Amazon.EC2.Model.DescribeTagsRequest)"> <summary> Describes Tags for the specified resources. </summary> <param name="request">Describe Tags request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Tags Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest)"> <summary> Describes the specified Amazon EBS volumes that you own. </summary> <remarks> If you do not specify one or more volume IDs, Amazon EBS describes all volumes that you own. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Describe Volumes request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Volumes Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DetachVolume(Amazon.EC2.Model.DetachVolumeRequest)"> <summary> Detaches an Amazon EBS volume from an instance. </summary> <remarks> For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. Important - make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to unmount file systems, or otherwise properly release the device from use, can result in lost data and will corrupt the file system. </remarks> <param name="request">Detach Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest)"> <summary> Disassociates the specified elastic IP address from the instance to which it is assigned. </summary> <remarks> This is an idempotent operation. If you call it more than once, Amazon EC2 does not return an error. </remarks> <param name="request">Disassociate Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Disassociate Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.GetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest)"> <summary> Retrieves the encrypted administrator password for the instances running Windows. </summary> <remarks> The Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided. </remarks> <param name="request">Get Password Data request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Get Password Data Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.GetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest)"> <summary> Retrieves console output for the specified instance. </summary> <remarks> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour after the most recent post. </remarks> <param name="request">Get Console Output request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Get Console Output Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest)"> <summary> Imports the public key from an RSA key pair created with a third-party tool. </summary> <remarks> This operation differs from CreateKeyPair as the private key is never transferred between the caller and AWS servers. RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the ssh-keygen command line tool provided with the standard OpenSSH installation. Standard library support for RSA key pair creation is also available for Java, Ruby, Python, and many other programming languages. The following formats are supported: - OpenSSH public key format, - Base64 encoded DER format. - SSH public key file format as specified in RFC4716. </remarks> <param name="request">Import Key Pair request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Import Key Pair Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest)"> <summary> Adds or remove permission settings for the specified snapshot </summary> <param name="request">Modify Snapshot Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Snapshot Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest)"> <summary> Modifies an attribute of an AMI </summary> <param name="request">Modify Image Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Image Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.PurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest)"> <summary> Purchases a Reserved Instance for use with your account. </summary> <remarks> With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Purchase Reserved Instances Offering request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Purchase Reserved Instances Offering Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.RebootInstances(Amazon.EC2.Model.RebootInstancesRequest)"> <summary> <para>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> <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">Reboot Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reboot Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.RegisterImage(Amazon.EC2.Model.RegisterImageRequest)"> <summary> Registers an AMI with Amazon EC2. </summary> <remarks> Images must be registered before they can be launched. To launch instances, use the RunInstances operation. Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image. The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. To deregister an image, use the DeregisterImage operation. </remarks> <param name="request">Register Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Register Image Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest)"> <summary> Releases an elastic IP address associated with your account. </summary> <remarks> If you run this operation on an elastic IP address that is already released, the address might be assigned to another account which will cause Amazon EC2 to return an error. Releasing an IP address automatically disassociates it from any instance with which it is associated. To disassociate an IP address without releasing it, use the DisassociateAddress operation. After releasing an elastic IP address, it is released to the IP // address pool and might no longer be available to your account. Make sure to update your DNS records and any servers or devices that communicate with the address. </remarks> <param name="request">Release Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Release Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest)"> <summary> Resets permission settings for the specified snapshot </summary> <param name="request">Reset Snapshot Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Snapshot Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest)"> <summary> Resets an attribute of an AMI to its default value. Note - The productCodes attribute cannot be reset. </summary> <param name="request">Reset Image Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Image Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.RevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest)"> <summary> Revokes permissions from a security group. </summary> <remarks> The permissions used to revoke must be specified using the same values used to grant the permissions. Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). Permission changes are quickly propagated to instances within the security group. However, depending on the number of instances in the group, a small delay is might occur. </remarks> <param name="request">Revoke Security Group Ingress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Revoke Security Group Ingress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.RunInstances(Amazon.EC2.Model.RunInstancesRequest)"> <summary> <para>Launches the specified number of instances using an AMI for which you have permissions.</para> <para>When you launch an instance, it enters the <c>pending</c> state. After the instance is ready for you, it enters the <c>running</c> state. To check the state of your instance, call DescribeInstances.</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>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, <c>RunInstances</c> 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">Run Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Run Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.StopInstances(Amazon.EC2.Model.StopInstancesRequest)"> <summary> <para>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> <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">Stop Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Stop Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.StartInstances(Amazon.EC2.Model.StartInstancesRequest)"> <summary> Starts an Amazon EBS-backed AMI that you've previously stopped. </summary> <remarks> <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, we charge 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> </remarks> <param name="request">Start Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Start Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest)"> <summary> Modifies an attribute of an instance. </summary> <param name="request">Modify Instance Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Instance Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest)"> <summary> Resets an attribute of an instance to its default value. </summary> <param name="request">Reset Instance Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Instance Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest)"> <summary> Gets information about an attribute of an instance. Only one attribute can be specified per call. </summary> <param name="request">Describe Instance Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Instance Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.TerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest)"> <summary> <para>Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.</para> <para>Terminated instances remain visible after termination (for approximately one hour).</para> <para>By default, Amazon EC2 deletes all Amazon 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, 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/TroubleshootingInstancesShuttingDown.html" >Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> </summary> <param name="request">Terminate Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Terminate Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.MonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest)"> <summary> Enables monitoring for a running instance. </summary> <param name="request">Monitor Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Monitor Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.UnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest)"> <summary> Disables monitoring for a running instance. </summary> <param name="request">Unmonitor Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Unmonitor Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest)"> <summary> Gives you information about your VPN connections. Important - we strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. You can filter the results to return information only about VPN connections that match criteria you specify. For example, you could ask to get information about a particular VPN connection (or all) only if the VPN's state is pending or available. You can specify multiple filters (e.g., the VPN connection is associated with a particular VPN gateway, and the gateway's state is pending or available). The result includes information for a particular VPN connection only if the VPN connection matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN connection ID. 2. The type of connection. 3. Customer gateway ID. 4. VPN gateway ID. 5. The current state of the VPN connection (pending, available, deleting, deleted). 6. The customer gateway configuration information in the native XML format. </summary> <param name="request">Describe Vpn Connections request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpn Connections Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest)"> <summary> Gives you information about your subnets. </summary> <remarks> You can filter the results to return information only about subnets that match criteria you specify. For example, you could ask to get information about a particular subnet (or all) only if the subnet's state is available. You can specify multiple filters (e.g., the subnet is in a particular VPC, and the subnet's state is available). The result includes information for a particular subnet only if the subnet matches all your filters. If there's no match, no special message is returned; the response is simply empty </remarks> <param name="request">Describe Subnets request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Subnets Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest)"> <summary> Detaches a VPN gateway from a VPC. </summary> <remarks> You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a VPN gateway has been completely detached from a VPC by describing the VPN gateway (any attachments to the VPN gateway are also described). You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the VPN gateway. </remarks> <param name="request">Detach Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest)"> <summary> Gives you information about your VPCs. </summary> <remarks> You can filter the results to return information only about VPCs that match criteria you specify. For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if the VPC matches all your filters. If there's no match, no special message is returned; the response is simply empty. The information returned consists of: a) The VPC ID. b) The CIDR block you've assigned to the VPC. c) The ID of the DHCP options you've associated with the VPC (or "default" if the default options are associated with the VPC) The current state of the VPC (pending or available) </remarks> <param name="request">Describe Vpcs request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpcs Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest)"> <summary> Deletes a customer gateway. </summary> <remarks> You must delete the VPN connection before deleting the customer gateway. AWS might delete any customer gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer gateway). </remarks> <param name="request">Delete Customer Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Customer Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest)"> <summary> Attaches a virtual private gateway to a VPC. </summary> <remarks> This is the last step required to get your VPC fully connected to your data center before launching instances in it. </remarks> <param name="request">Attach Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest)"> <summary> Deletes a set of DHCP options that you specify. </summary> <remarks> Amazon VPC returns an error if the set of options you specify is currently associated with a VPC. You can disassociate the set of options by associating either a new set of options or the default options with the VPC. </remarks> <param name="request">Delete Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest)"> <summary> Deletes a subnet from a VPC. </summary> <remarks> You must terminate all running instances in the subnet before deleting it, otherwise Amazon VPC returns an error. AWS might delete any subnet if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet). </remarks> <param name="request">Delete Subnet request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Subnet Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateVpc(Amazon.EC2.Model.CreateVpcRequest)"> <summary> Creates a VPC with the CIDR block you specify. </summary> <remarks> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /18 netmask (16,384 IP addresses). To help you decide how big to make your VPC, go to the topic about creating VPCs in the Amazon Virtual Private Cloud Developer Guide. By default, each instance you launch in the VPC has the default DHCP options (the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type). AWS might delete any VPC that you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC). </remarks> <param name="request">Create Vpc request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpc Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest)"> <summary> Provides information to AWS about your customer gateway device. </summary> <remarks> The customer gateway is the appliance at your end of the VPN connection (compared to the VPN gateway, which is the device at the AWS side of the VPN connection). AWS might delete any customer gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer 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). For device’s that use Border Gateway Protocal (BGP), you can also provide the device's Border Gateway Protocol (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). Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in US East, and 9059, which is reserved in EU West For more information about ASNs, go to the Wikipedia article - http://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29. </remarks> <param name="request">Create Customer Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Customer Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest)"> <summary> Creates a new VPN gateway. </summary> <remarks> A VPN gateway is the VPC-side endpoint for your VPN connection. You can create a VPN gateway before creating the VPC itself. AWS might delete any VPN gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway) </remarks> <param name="request">Create Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteVpc(Amazon.EC2.Model.DeleteVpcRequest)"> <summary> Deletes a VPC. </summary> <remarks> You must terminate all running instances and delete all subnets before deleting the VPC, otherwise Amazon VPC returns an error. AWS might delete any VPC if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC). </remarks> <param name="request">Delete Vpc request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpc Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest)"> <summary> Associates a set of DHCP options (that you've previously created) with the specified VPC. Or, associates the default DHCP options with the VPC. </summary> <remarks> The default set consists of the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. For more information about the supported DHCP options and using them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual Private Cloud Developer Guide. </remarks> <param name="request">Associate Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Associate Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest)"> <summary> Gives you information about your VPN gateways. </summary> <remarks> You can filter the results to return information only about VPN gateways that match criteria you specify. For example, you could ask to get information about a particular VPN gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the VPN gateway is in a particular Availability Zone and the gateway's state is pending or available). The result includes information for a particular VPN gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN gateway ID - The current state of the VPN gateway (pending, available, deleting, deleted) 2. The type of VPN connection the VPN gateway supports. 3. The Availability Zone where the VPN gateway was created. 4. The VPCs the VPN gateway is attached to and the state of each attachment (attaching, attached, detaching, detached) </remarks> <param name="request">Describe Vpn Gateways request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpn Gateways Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateSubnet(Amazon.EC2.Model.CreateSubnetRequest)"> <summary> Creates a subnet in an existing VPC. </summary> <remarks> You can create up to 20 subnets in a VPC. 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. If you feel you need more than 20 subnets, you can request more by going to http://aws.amazon.com/contact-us/vpc-request/. When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. Once 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 /18 netmask (16,384 IP addresses). *Important* AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. AWS might delete any subnet you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet). </remarks> <param name="request">Create Subnet request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Subnet Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest)"> <summary> Deletes a VPN connection. </summary> <remarks> This operation will delete a VPC and all its associated components. Another reason to use this operation is if you believe the tunnel credentials for your VPN connection have been compromised. In that situation, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or VPN 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. If you're deleting the VPC and all its associated parts, we recommend you detach the VPN gateway from the VPC and delete the VPC before deleting the VPN connection. </remarks> <param name="request">Delete Vpn Connection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpn Connection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest)"> <summary> Deletes a VPN gateway. </summary> <remarks> Use this when you want to delete a VPC and all its associated components because you no longer need them. We recommend that before you delete a VPN gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the VPN gateway if you just want to delete and re-create the VPN connection between your VPC and data center. AWS might delete any VPN gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway). </remarks> <param name="request">Delete Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest)"> <summary> Returns information about your customer gateways. </summary> <remarks> You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could ask to get information about a particular customer gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the customer gateway has a particular IP address for the Internet-routable external interface, and the gateway's state is pending or available). The result includes information for a particular customer gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty </remarks> <param name="request">Describe Customer Gateways request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Customer Gateways Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.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 ipsec.1. </summary> <remarks> The response includes information that you need to configure your customer gateway, in XML format. It is strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. If you 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 CreateVpnConnection. </remarks> <param name="request">Create Vpn Connection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpn Connection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest)"> <summary> Gives you information about one or more sets of DHCP options. You can specify one or more DHCP options set IDs, or no IDs (to describe all your sets of DHCP options). </summary> <remarks> The returned information consists of: 1. The DHCP options set ID 2. The options </remarks> <param name="request">Describe Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest)"> <summary> <para>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> .</para> <ul> <li> <c>domain-name-servers</c> - The IP addresses of up to four domain name servers, or <c>AmazonProvidedDNS</c> . The default DHCP option set specifies <c>AmazonProvidedDNS</c> . If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <c>domain-name</c> - If you're using AmazonProvidedDNS in <c>us-east-1</c> , specify <c>ec2.internal</c> . If you're using AmazonProvidedDNS in another region, specify <c>region.compute.internal</c> (for example, <c>ap-northeast-1.compute.internal</c> ). Otherwise, specify a domain name (for example, <c>MyCompany.com</c> ).</li> <li> <c>ntp-servers</c> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <c>netbios-name-servers</c> - The IP addresses of up to four NetBIOS name servers.</li> <li> <c>netbios-node-type</c> - 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>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">Create Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.RequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest)"> <summary> Creates a Spot Instance request. </summary> <remarks> Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum 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. </remarks> <param name="request">Request Spot Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Request Spot Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest)"> <summary> Describes the Spot Instance requests that belong to your account. </summary> <remarks> Spot Instances are instances that automatically launch when your request price exceeds that Spot Price that Amazon EC2 periodically calculates. </remarks> <param name="request">Describe Spot Instance Requests request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Spot Instance Requests Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest)"> <summary> Cancels one or more Spot Instance requests. </summary> <remarks> Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum 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. </remarks> <param name="request">Cancel Spot Instance Requests request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Spot Instance Requests Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest)"> <summary> Describes the Spot Price history. </summary> <param name="request">Describe Spot Price History request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Spot Price History Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest)"> <summary> Creates the datafeed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account. </summary> <param name="request">Create Spot Datafeed Subscription request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Spot Datafeed Subscription Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest)"> <summary> Describes the datafeed for Spot Instances. </summary> <param name="request">Describe Spot Datafeed Subscription request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Spot Datafeed Subscription Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest)"> <summary> Deletes the datafeed for Spot Instances. </summary> <param name="request">Delete Spot Datafeed Subscription request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Spot Datafeed Subscription Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest)"> <summary> Cancels an active conversion task. The task can be the import of an instance or volume. </summary> <remarks> The command 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. </remarks> <param name="request">Cancel Conversion Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Conversion Task Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest)"> <summary> Describes your conversion tasks. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide. </summary> <param name="request">Describe Conversion Tasks request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Conversion Tasks Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ImportInstance(Amazon.EC2.Model.ImportInstanceRequest)"> <summary> <para>Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.</para> </summary> <param name="request">Import Instance request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Import Instance Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ImportVolume(Amazon.EC2.Model.ImportVolumeRequest)"> <summary> <para>Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume 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> .</para> </summary> <param name="request">Import Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Import Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest)"> <summary> Adds one or more egress rules to a VPC security group. </summary> <remarks> <para> This call permits instances in a security group to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups in the same VPC. </para> <para> This action applies only to security groups in a VPC; it's not supported for standard (EC2) security groups. </para> <para> Each rule consists of the protocol (e.g., 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 as a wildcard for the ICMP type or code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </remarks> <param name="request">Authorize Security Group Egress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Authorize Security Group Egress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.RevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest)"> <summary> Removes one or more egress rules from a VPC security group. </summary> <remarks> This action applies only to security groups in a VPC. It doesn't work with standard (EC2) security groups. For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual Private Cloud User Guide. The values that you specify in the revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to be revoked. Each rule consists of the protocol, and the CIDR range or destination 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. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </remarks> <param name="request">Revoke Security Group Egress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Revoke Security Group Egress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest)"> <summary> Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway. </summary> <param name="request">Create Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Internet Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest)"> <summary> Gives you information about your Internet gateways. </summary> <remarks> You can filter the results to return information only about Internet gateways that match criteria you specify. For example, you could get information only about gateways with particular tags. The Internet gateway must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged with a particular value). The result includes information for a particular Internet gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> <param name="request">Describe Internet Gateways request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Internet Gateways Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest)"> <summary> Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide. </summary> <param name="request">Delete Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Internet Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest)"> <summary> Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. </summary> <param name="request">Attach Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Internet Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest)"> <summary> Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. </summary> <remarks> The VPC must not contain any running instances with elastic IP addresses. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Detach Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Internet Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest)"> <summary> Creates a route table within a VPC. After you create a new route table, you can add routes and associate the table with a subnet. </summary> <param name="request">Create Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Route Table Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest)"> <summary> Gives you information about your route tables. </summary> <remarks> You can filter the results to return information only about tables that match criteria you specify. For example, you could get information only about a table associated with a particular subnet.You can specify multiple values for the filter. The table must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the table has a particular route, and is associated with a particular subnet). The result includes information for a particular table only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> <param name="request">Describe Route Tables request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Route Tables Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest)"> <summary> Deletes a route table from a VPC. The route table must not be associated with a subnet. You can't delete the main route table. </summary> <param name="request">Delete Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Route Table Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest)"> <summary> Associates a subnet with a route table. </summary> <remarks> 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 if you want to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. </remarks> <param name="request">Associate Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Associate Route Table Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest)"> <summary> Changes the route table associated with a given subnet in a VPC. </summary> <remarks> After you execute this action, the subnet uses the routes in the new route table it's associated with. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Route Table Association request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Route Table Association Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest)"> <summary> Disassociates a subnet from a route table. </summary> <remarks> 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, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Disassociate Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Disassociate Route Table Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateRoute(Amazon.EC2.Model.CreateRouteRequest)"> <summary> Creates a new route in a route table within a VPC. The route's target can be either a gateway attached to the VPC or a NAT instance in the VPC. </summary> <remarks> 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 192.0.2.3, and the route table includes the following two routes: 192.0.2.0/24 (goes to some target A) 192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list is more specific, so we use that route to determine where to target the traffic. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Create Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Route Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest)"> <summary> Replaces an existing route within a route table in a VPC. </summary> <remarks> For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Route Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteRoute(Amazon.EC2.Model.DeleteRouteRequest)"> <summary> Deletes a route from a route table in a VPC. </summary> <param name="request">Delete Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Route Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest)"> <summary> Creates a network ACL in a VPC. </summary> <remarks> Network ACLs provide an optional layer of security (on top of security groups) for the instances in your VPC. </remarks> <param name="request">Create Network Acl request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Network Acl Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest)"> <summary> Gives you information about the network ACLs in your VPC. </summary> <remarks> You can filter the results to return information only about ACLs that match criteria you specify. For example, you could get information for only the ACL associated with a particular subnet. The ACL must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an egress entry that denies traffic to a particular port). The result includes information for a particular ACL only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character.You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> <param name="request">Describe Network Acls request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Network Acls Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest)"> <summary> Deletes a network ACL from a VPC. </summary> <remarks> The ACL must not have any subnets associated with it. You can't delete the default network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Delete Network Acl request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Network Acl Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest)"> <summary> Changes which network ACL a subnet is associated with. </summary> <remarks> By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Network Acl Association request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Network Acl Association Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest)"> <summary> Creates an entry (i.e., rule) in a network ACL with a rule number you specify. </summary> <remarks> 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, Amazon VPC processes the entries in the ACL according to the rule numbers, in ascending order. We recommend that you leave room between the rules (e.g., 100, 110, 120, etc.), and not number them sequentially (101, 102, 103, etc.). This allows you to easily add a new rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create a new entry and delete the old one. </remarks> <param name="request">Create Network Acl Entry request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Network Acl Entry Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest)"> <summary> Replaces an entry (i.e., rule) in a network ACL. </summary> <remarks> For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Network Acl Entry request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Network Acl Entry Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest)"> <summary> Deletes an ingress or egress entry (i.e., rule) from a network ACL. </summary> <remarks> For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Delete Network Acl Entry request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Network Acl Entry Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest)"> <summary> Attaches a network interface to an instance. </summary> <param name="request">Attach Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest)"> <summary> Creates a network interface in the specified subnet. </summary> <remarks> This action is supported only in Amazon VPC. </remarks> <param name="request">Create Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest)"> <summary> Deletes the specified network interface. </summary> <param name="request">Delete Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest)"> <summary> Describes a Network Interface Attribute. Only one attribute can be specified per call. </summary> <remarks>Only one attribute can be specified per call.</remarks> <param name="request">Describe Network Interface Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Network Interface Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest)"> <summary> Describes one or more Network Interfaces. </summary> <param name="request">Describe Network Interfaces request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Network Interfaces response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest)"> <summary> Detaches a network interface from an instance. </summary> <param name="request">Detach Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest)"> <summary> Modifies a network interface attribute. Only one attribute can be specified per call. </summary> <remarks>Only one attribute can be specified per call.</remarks> <param name="request">Modify Network Interface Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Network Interface Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest)"> <summary> Reset Network Interface Attribute request </summary> <remarks>Only one attribute can be specified per call.</remarks> <param name="request">Reset Network Interface Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Network Interface Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest)"> <summary> Returns the status of one or more volumes. </summary> <param name="request">Describe Volume Status request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Volume Status response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.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">Enable Volume IO request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Enable Volume IO response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest)"> <summary> Modifies a volume attribute. </summary> <param name="request">Modify Volume Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Volume Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest)"> <summary> Describes an attribute of a volume. </summary> <param name="request">Describe Volume Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Volume Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest)"> <summary> Assigns one or more secondary private IP addresses to a network interface in Amazon VPC. </summary> <remarks> You can specify one or more specific secondary IP addresses that you want to assign, or you can specify a 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. </remarks> <param name="request">Assign Private Ip Addresses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Assign Private Ip Addresses response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.UnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest)"> <summary> Unassigns one or more secondary private IP addresses from a network interface in Amazon VPC. This command is only available in Amazon VPC </summary> <param name="request">Unassign Private Ip Addresses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Unassign Private Ip Addresses response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest)"> <summary> Creates a new 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> <remarks> We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </remarks> <param name="request">Create Vpn Connection Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpn Connection Route response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest)"> <summary> Deletes 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. </summary> <remakrs> We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </remakrs> <param name="request">Delete Vpn Connection Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpn Connection Route response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.EnableVGWRoutePropagation(Amazon.EC2.Model.EnableVGWRoutePropagationRequest)"> <summary> Enables a virtual private gateway (VGW) to propagate routes to the routing tables of an Amazon VPC. </summary> <param name="request">Enable Virtual Gateway Route Propagation request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Enable Virtual Gateway Route Propagation response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DisableVGWRoutePropagation(Amazon.EC2.Model.DisableVGWRoutePropagationRequest)"> <summary> Disables a virtual private gateway (VGW) from propagating routes to the routing tables of an Amazon VPC. </summary> <param name="request">Disable Virtual Gateway Route Propagation request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Disable Virtual Gateway Route Propagation response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest)"> <summary> Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. </summary> <param name="request">Cancel Reserved Instances Listing request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Reserved Instances Listing response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest)"> <summary> Creates a new listing for Amazon EC2 Reserved Instances that will be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. </summary> <remarks> 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. If you want 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 you want to receive for them. Your Reserved Instance listings then become available for purchase. </remarks> <param name="request">Create Reserved Instances Listing request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Reserved Instances Listing response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest)"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. </summary> <param name="request">Describe Reserved Instances Listing request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Reserved Instances Listing response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CopySnapshot(Amazon.EC2.Model.CopySnapshotRequest)"> <summary> <para>Copies a point-in-time snapshot of an Amazon 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 Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.</para> <para>Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.</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">Copy Snapshot request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Copy Snapshot response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CopyImage(Amazon.EC2.Model.CopyImageRequest)"> <summary> <para>Initiates the copy of an AMI from the specified source region to the region in which the request was made. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.</para> <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">Copy Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Copy Image response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest)"> <summary> Describes VPC attributes. </summary> <param name="request">Describe Vpc Attributes Request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpc Attributes response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.ModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest)"> <summary> Modified attributes on a VPC. </summary> <param name="request">Modify Vpc Attributes Request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Vpc Attributes response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest)"> <summary> Describes account attributes of the caller </summary> <param name="request">Describe Account Attributes Request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Account Attributes response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest)"> <summary> Creates a new export task, produces an image of an EC2 instance for use in another virtualization environment, and then writes the image to the specified Amazon S3 bucket. If the instance is running at the time of export, Amazon EC2 will attempt to shut down the instance, initiate the export process, and then reboot the instance. Only instances derived from your own ImportInstance tasks may be exported. When the task is complete, the image can be downloaded from your Amazon S3 bucket. </summary> <param name="request">Create Instance Export Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Instance Export Task response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest)"> <summary> Describes your export tasks. If no export task IDs are specified, all export tasks initiated by you are returned. </summary> <param name="request">Describe Export Tasks request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Export Tasks response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest)"> <summary> Cancels an active export task. The command 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">Cancel Export Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Export Task response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest)"> <summary> Describes modifications made to Reserved Instances in your account. </summary> <param name="request">Describe Reserved Instances Modifications request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Reserved Instances Modifications response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.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. </summary> <param name="request">Modify Reserved Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Reserved Instances response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.RejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest)"> <summary> <para>Rejects a VPC peering connection request. The VPC peering connection must be in the <c>pending-acceptance</c> state. Use the <c>DescribeVpcPeeringConnections</c> request to view your outstanding VPC peering connection requests.</para> </summary> <param name="request">RejectVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>RejectVpcPeeringConnection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest)"> <summary> <para>Describes one or more of your VPC peering connections.</para> </summary> <param name="request">DescribeVpcPeeringConnections request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>DescribeVpcPeeringConnections Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.DeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest)"> <summary> <para>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 <c>active</c> state. The owner of the requester VPC can delete a VPC peering connection in the <c>pending-acceptance</c> state.</para> </summary> <param name="request">DeleteVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>DeleteVpcPeeringConnection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.CreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest)"> <summary> <para>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> <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 <c>CreateVpcPeeringConnection</c> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <c>failed</c> .</para> </summary> <param name="request">CreateVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>CreateVpcPeeringConnection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2.AcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest)"> <summary> <para>Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <c>pending-acceptance</c> state, and you must be the owner of the peer VPC. Use the <c>DescribeVpcPeeringConnections</c> request to view your outstanding VPC peering connection requests.</para> </summary> <param name="request">AcceptVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>AcceptVpcPeeringConnection Response from the service</returns> </member> <member name="T:Amazon.EC2.AmazonEC2Client"> <summary> AmazonEC2Client is an implementation of AmazonEC2; the client allows you to manage your AmazonEC2 resources.<br /> If you want to use the AmazonEC2Client from a Medium Trust hosting environment, please create the client with an AmazonEC2Config object whose UseSecureStringForAwsSecretKey property is false. </summary> <remarks> The Amazon Elastic Compute Cloud (Amazon EC2) web service provides you with the ability to execute your applications in Amazon's computing environment. To use Amazon EC2 you simply: 1. Create an Amazon Machine Image (AMI) containing all your software, including your operating system and associated configuration settings, applications, libraries, etc. Think of this as zipping up the contents of your hard drive. We provide all the necessary tools to create and package your AMI. 2. Upload this AMI to the Amazon S3 (Amazon Simple Storage Service) service. This gives us reliable, secure access to your AMI. 3. Register your AMI with Amazon EC2. This allows us to verify that your AMI has been uploaded correctly and to allocate a unique identifier for it. 4. Use this AMI ID and the Amazon EC2 web service APIs to run, monitor, and terminate as many instances of this AMI as required. You can also skip the first three steps and choose to launch an AMI that is provided by Amazon or shared by another user. While instances are running, you are billed for the computing and network resources that they consume. You can also skip the first three steps and choose to launch an AMI that is provided by Amazon or shared by another user. While instances are running, you are billed for the computing and network resources that they consume. </remarks> <seealso cref="P:Amazon.EC2.AmazonEC2Config.UseSecureStringForAwsSecretKey"/> </member> <member name="M:Amazon.EC2.AmazonEC2Client.Dispose(System.Boolean)"> <summary> Implements the Dispose pattern for the AmazonEC2Client </summary> <param name="fDisposing">Whether this object is being disposed via a call to Dispose or garbage collected.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="M:Amazon.EC2.AmazonEC2Client.Finalize"> <summary> The destructor for the client class. </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect to.</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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonEC2 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 to.</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 AmazonEC2 Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="config">The AmazonEC2 Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.Security.SecureString,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs an AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an AmazonEC2 Configuration object </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key as a SecureString</param> <param name="config">The AmazonEC2 Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.Security.SecureString,Amazon.RegionEndpoint)"> <summary> Constructs an AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an AmazonEC2 Configuration object </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key as a SecureString</param> <param name="region">The region to connect to.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs an AmazonEC2Client with AWSCredentials </summary> <param name="credentials"></param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs an AmazonEC2Client with AWSCredentials </summary> <param name="credentials"></param> <param name="region">The region to connect to.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs an AmazonEC2Client with AWSCredentials and an AmazonEC2 Configuration object </summary> <param name="credentials"></param> <param name="config"></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 AmazonEC2Config Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.DryRun(Amazon.EC2.Model.EC2Request)"> <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="M:Amazon.EC2.AmazonEC2Client.ActivateLicense(Amazon.EC2.Model.ActivateLicenseRequest)"> <summary> Activates a license. </summary> <remarks> Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID. </remarks> <param name="request">Activate License request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Activate License Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AllocateAddress(Amazon.EC2.Model.AllocateAddressRequest)"> <summary> Acquires an elastic IP address for use with your account or your VPC. </summary> <param name="request">Allocate Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Allocate Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateAddress(Amazon.EC2.Model.AssociateAddressRequest)"> <summary> Associates an elastic IP address with an instance. If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. </summary> <remarks> This is an idempotent operation. If you call it more than once, Amazon EC2 does not return an error. </remarks> <param name="request">Associate Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Associate Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVolume(Amazon.EC2.Model.AttachVolumeRequest)"> <summary> <para>Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.</para> <para>Encrypted Amazon 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 Amazon EBS Volume to an Instance</a> . Any device names that aren't reserved for instance store volumes can be used for Amazon 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 only be attached as the root device of a stopped instance.</li> <li>You must be subscribed to the AWS Marketplace code that is on the volume.</li> <li>The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> </ul> <para>For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000" >https://aws.amazon.com/marketplace/help/200900000</a> . For more information about how to use the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace" >AWS Marketplace</a> .</para> <para>For more information about Amazon 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">Attach Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest)"> <summary> Adds one or more ingress rules to a security group. This action applies to both EC2 security groups and VPC security groups. </summary> <remarks> Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields. Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur. When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission, GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified </remarks> <param name="request">Authorize Security Group Ingress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Authorize Security Group Ingress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BundleInstance(Amazon.EC2.Model.BundleInstanceRequest)"> <summary> Bundles an Amazon instance store-backed Windows instance. This procedure is not applicable for Linux and UNIX instances. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </summary> <param name="request">Bundle Instance request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Bundle Instance Response from the service</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">Cancel Bundle Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Bundle Task Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest)"> <summary> Determines whether a product code is associated with an instance. </summary> <remarks> 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 EC2 user’s instance is eligible for support. </remarks> <param name="request">Confirm Product Instance request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Confirm Product Instance Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateImage(Amazon.EC2.Model.CreateImageRequest)"> <summary> Creates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started. </summary> <param name="request">Create Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Image Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest)"> <summary> Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is returned to you. </summary> <remarks> 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. The key pair returned to you works only in the Region you're using when you create the key pair. To create a key pair that works in all Regions, use ImportKeyPair. </remarks> <param name="request">Create Key Pair request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Key Pair Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest)"> <summary> Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched. Users must give the group a name unique within the scope of the user account. </summary> <param name="request">Create Placement Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Placement Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest)"> <summary> Creates a new security group. Group names must be unique per account. </summary> <remarks> Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations. </remarks> <param name="request">Create Security Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Security Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest)"> <summary> <para>Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.</para> <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 Amazon 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 writes to 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 <c>pending</c> .</para> <para>To create a snapshot for Amazon 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">Create Snapshot request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Snapshot Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateTags(Amazon.EC2.Model.CreateTagsRequest)"> <summary> Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags. Each tag consists of a key-value pair. Tag keys must be unique per resource. </summary> <param name="request">Create Tags request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Tags Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVolume(Amazon.EC2.Model.CreateVolumeRequest)"> <summary> <para>Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the specified region.</para> <para>You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.</para> <para>You can create encrypted volumes with the <c>Encrypted</c> 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">Create Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeactivateLicense(Amazon.EC2.Model.DeactivateLicenseRequest)"> <summary> Deactivates a specific number of licenses. </summary> <remarks> Deactivations can be done against a specific license ID after they have persisted for at least a 90-day period. </remarks> <param name="request">Deactivate License request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Deactivate License Response from the service</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. You must own the key pair. </summary> <param name="request">Delete Key Pair request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Key Pair Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest)"> <summary> Deletes a PlacementGroupfrom a user's account. Terminate all Amazon EC2 instances in the placement group before deletion. </summary> <param name="request">Delete Placement Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Placement Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest)"> <summary> Deletes a security group that you own. </summary> <remarks> If you attempt to delete a security group that contains instances, an error is returned. If you attempt to delete a security group that is referenced by another security group, an error is returned. For example, if security group B has a rule that allows access from security group A, security group A cannot be deleted until the allow rule is removed. </remarks> <param name="request">Delete Security Group request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Security Group Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest)"> <summary> Deletes a snapshot of an Amazon EBS volume that you own. </summary> <param name="request">Delete Snapshot request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Snapshot Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteTags(Amazon.EC2.Model.DeleteTagsRequest)"> <summary> Deletes tags from the specified resources. </summary> <param name="request">Delete Tags request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Tags Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest)"> <summary> <para>Deletes the specified Amazon EBS volume. The volume must be in the <c>available</c> state (not attached to an instance).</para> <para><b>NOTE:</b> The volume may remain in the deleting state for several minutes. </para> <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">Delete Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeregisterImage(Amazon.EC2.Model.DeregisterImageRequest)"> <summary> Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. </summary> <remarks> This command does not delete the AMI from Amazon S3. </remarks> <param name="request">Deregister Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Deregister Image Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest)"> <summary> Lists elastic IP addresses assigned to your account or provides information about a specific address. </summary> <param name="request">Describe Addresses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Addresses Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest)"> <summary> Lists Availability Zones that are currently available to the account and their states. </summary> <remarks> Availability Zones are not the same across accounts. The Availability Zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account. </remarks> <param name="request">Describe Availability Zones request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Availability Zones Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest)"> <summary> Describes current bundling tasks. </summary> <remarks> Describes in-progress and recent bundle tasks. Complete and failed tasks are removed from the list a short time after completion. If no bundle ids are given, all bundle tasks are returned. </remarks> <param name="request">Describe Bundle Tasks request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Bundle Tasks Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeLicenses(Amazon.EC2.Model.DescribeLicensesRequest)"> <summary> Provides details of a user's registered licenses. </summary> <remarks> Zero or more IDs may be specified on the call. When one or more license IDs are specified, only data for the specified IDs are returned. </remarks> <param name="request">Describe Licenses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Licenses Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest)"> <summary> Returns information about one or more PlacementGroup instances in a user's account. </summary> <param name="request">Describe Placement Groups request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Placement Groups Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest)"> <summary> Returns information about an attribute of a snapshot. Only one attribute can be specified per call. </summary> <param name="request">Describe Snapshot Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Snapshot Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest)"> <summary> Gets information about an attribute of an AMI. Only one attribute can be specified per call. </summary> <param name="request">Describe Image Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Image Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImages(Amazon.EC2.Model.DescribeImagesRequest)"> <summary> Returns information about AMIs, AKIs, and ARIs. This includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to you include public images, private images that you own, and private images owned by other users for which you have explicit launch permissions. </summary> <remarks> Launch permissions fall into three categories: 1. public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs. 2. explicit: The owner of the AMI granted launch permissions to a specific user. 3. implicit: A user has implicit launch permissions for all AMIs he or she owns. The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions. If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results. If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own. If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs. </remarks> <param name="request">Describe Images request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Images Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest)"> <summary> <para>Describes the status of one or more instances, including any scheduled events.</para> <para>Instance status has two main components:</para> <ul> <li> <para>System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.</para> </li> <li> <para>Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.</para> </li> </ul> <para>Instance status provides information about four types of scheduled events for an instance that may require your attention:</para> <ul> <li> <para>Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: <c>system-reboot</c> or <c>instance-reboot</c> . System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.</para> </li> <li> <para>System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code <c>system-maintenance</c> . System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.</para> </li> <li> <para>Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code <c>instance-retirement</c> . Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.</para> </li> <li> <para>Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called <c>instance-stop</c> . Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.</para> </li> </ul> <para>When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is <c>instance-retirement</c> . This ensures that your instance is started on a different underlying host.</para> <para>For more information about failed status checks, see <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> . For more information about working with scheduled events, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#schedevents_actions" >Working with an Instance That Has a Scheduled Event</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> </summary> /// <param name="request">Describe Instance Status request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Instance Status response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest)"> <summary> Submits feedback about an instance's status. </summary> <remarks> This action works only for instances that are in the running state. If your experience with the instance differs from the instance status returned by the DescribeInstanceStatus action, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. </remarks> <param name="request">Report Instance Status request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Report Instance Status response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest)"> <summary> Returns information about instances that you own. </summary> <remarks> 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 invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results. Recently terminated instances might appear in the returned results.This interval is usually less than one hour. </remarks> <param name="request">Describe Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest)"> <summary> Describes regions that are currently available to the account. </summary> <param name="request">Describe Regions request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Regions Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest)"> <summary> Describes Reserved Instances that you purchased. </summary> <remarks> For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Describe Reserved Instances request</param> <returns>Describe Reserved Instances Response from the service</returns> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest)"> <summary> Describes Reserved Instance offerings that are available for purchase. </summary> <remarks> With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Describe Reserved Instances Offerings request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Reserved Instances Offerings Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest)"> <summary> Returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned. </summary> <param name="request">Describe Key Pairs request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Key Pairs Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest)"> <summary> Returns information about security groups that you own. </summary> <remarks> If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned. </remarks> <param name="request">Describe Security Groups request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Security Groups Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest)"> <summary> Returns information about Amazon EBS snapshots available to the user. </summary> <remarks> Information returned includes volume ID, status, start time, progress, owner ID, volume size, and description. Snapshots available to the user include public snapshots available for any user to launch, private snapshots owned by the user making the request, and private snapshots owned by other users for which the user granted explicit create volume permissions. The create volume permissions fall into 3 categories: public The owner of the snapshot granted create volume permissions for the snapshot to the all group. All users have create volume permissions for these snapshots. explicit The owner of the snapshot granted create volume permissions to a specific user. implicit A user has implicit create volume permissions for all snapshots he or she owns. The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or users with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which the user has create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, a fault is returned. If you specify a snapshot ID for which you do not have access, it will not be included in the returned results. 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, amazon for snapshots owned by Amazon or self for snapshots that you own. If you specify a list of restorable users, only users that have create snapshot permissions for the snapshots are returned. You can specify AWS Account IDs (if you own the snapshot(s)), self for snapshots for which you own or have explicit permissions, or all for public snapshots. </remarks> <param name="request">Describe Snapshots request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Snapshots Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeTags(Amazon.EC2.Model.DescribeTagsRequest)"> <summary> Describes Tags for the specified resources. </summary> <param name="request">Describe Tags request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Tags Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest)"> <summary> Describes the specified Amazon EBS volumes that you own. </summary> <remarks> If you do not specify one or more volume IDs, Amazon EBS describes all volumes that you own. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Describe Volumes request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Volumes Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVolume(Amazon.EC2.Model.DetachVolumeRequest)"> <summary> Detaches an Amazon EBS volume from an instance. </summary> <remarks> For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. Important - make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to unmount file systems, or otherwise properly release the device from use, can result in lost data and will corrupt the file system. </remarks> <param name="request">Detach Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest)"> <summary> Disassociates the specified elastic IP address from the instance to which it is assigned. </summary> <remarks> This is an idempotent operation. If you call it more than once, Amazon EC2 does not return an error. </remarks> <param name="request">Disassociate Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Disassociate Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest)"> <summary> Retrieves the encrypted administrator password for the instances running Windows. </summary> <remarks> The Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided. </remarks> <param name="request">Get Password Data request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Get Password Data Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest)"> <summary> Retrieves console output for the specified instance. </summary> <remarks> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour after the most recent post. </remarks> <param name="request">Get Console Output request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Get Console Output Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest)"> <summary> Imports the public key from an RSA key pair created with a third-party tool. </summary> <remarks> This operation differs from CreateKeyPair as the private key is never transferred between the caller and AWS servers. RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the ssh-keygen command line tool provided with the standard OpenSSH installation. Standard library support for RSA key pair creation is also available for Java, Ruby, Python, and many other programming languages. The following formats are supported: - OpenSSH public key format, - Base64 encoded DER format. - SSH public key file format as specified in RFC4716. </remarks> <param name="request">Import Key Pair request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Import Key Pair Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest)"> <summary> Adds or remove permission settings for the specified snapshot </summary> <param name="request">Modify Snapshot Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Snapshot Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest)"> <summary> Modifies an attribute of an AMI </summary> <param name="request">Modify Image Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Image Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.PurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest)"> <summary> Purchases a Reserved Instance for use with your account. </summary> <remarks> With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> <param name="request">Purchase Reserved Instances Offering request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Purchase Reserved Instances Offering Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RebootInstances(Amazon.EC2.Model.RebootInstancesRequest)"> <summary> <para>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> <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">Reboot Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reboot Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RegisterImage(Amazon.EC2.Model.RegisterImageRequest)"> <summary> Registers an AMI with Amazon EC2. </summary> <remarks> Images must be registered before they can be launched. To launch instances, use the RunInstances operation. Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image. The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. To deregister an image, use the DeregisterImage operation. </remarks> <param name="request">Register Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Register Image Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest)"> <summary> Releases an elastic IP address associated with your account. </summary> <remarks> If you run this operation on an elastic IP address that is already released, the address might be assigned to another account which will cause Amazon EC2 to return an error. Releasing an IP address automatically disassociates it from any instance with which it is associated. To disassociate an IP address without releasing it, use the DisassociateAddress operation. After releasing an elastic IP address, it is released to the IP // address pool and might no longer be available to your account. Make sure to update your DNS records and any servers or devices that communicate with the address. </remarks> <param name="request">Release Address request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Release Address Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest)"> <summary> Resets permission settings for the specified snapshot </summary> <param name="request">Reset Snapshot Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Snapshot Attribute Response from the service</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 - The productCodes attribute cannot be reset. </summary> <param name="request">Reset Image Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Image Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest)"> <summary> Revokes permissions from a security group. </summary> <remarks> The permissions used to revoke must be specified using the same values used to grant the permissions. Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). Permission changes are quickly propagated to instances within the security group. However, depending on the number of instances in the group, a small delay is might occur. </remarks> <param name="request">Revoke Security Group Ingress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Revoke Security Group Ingress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RunInstances(Amazon.EC2.Model.RunInstancesRequest)"> <summary> <para>Launches the specified number of instances using an AMI for which you have permissions.</para> <para>When you launch an instance, it enters the <c>pending</c> state. After the instance is ready for you, it enters the <c>running</c> state. To check the state of your instance, call DescribeInstances.</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>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, <c>RunInstances</c> 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">Run Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Run Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.StopInstances(Amazon.EC2.Model.StopInstancesRequest)"> <summary> <para>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> <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">Stop Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Stop Instances Response from the service</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. </summary> <remarks> <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, we charge 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> </remarks> <param name="request">Start Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Start Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest)"> <summary> Modifies an attribute of an instance. </summary> <param name="request">Modify Instance Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Instance Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest)"> <summary> Resets an attribute of an instance to its default value. </summary> <param name="request">Reset Instance Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Instance Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest)"> <summary> Gets information about an attribute of an instance. Only one attribute can be specified per call. </summary> <param name="request">Describe Instance Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Instance Attribute Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.TerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest)"> <summary> <para>Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.</para> <para>Terminated instances remain visible after termination (for approximately one hour).</para> <para>By default, Amazon EC2 deletes all Amazon 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, 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/TroubleshootingInstancesShuttingDown.html" >Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> </summary> <param name="request">Terminate Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Terminate Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.MonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest)"> <summary> Enables monitoring for a running instance. </summary> <param name="request">Monitor Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Monitor Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.UnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest)"> <summary> Disables monitoring for a running instance. </summary> <param name="request">Unmonitor Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Unmonitor Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest)"> <summary> Gives you information about your VPN connections. Important - we strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. You can filter the results to return information only about VPN connections that match criteria you specify. For example, you could ask to get information about a particular VPN connection (or all) only if the VPN's state is pending or available. You can specify multiple filters (e.g., the VPN connection is associated with a particular VPN gateway, and the gateway's state is pending or available). The result includes information for a particular VPN connection only if the VPN connection matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN connection ID. 2. The type of connection. 3. Customer gateway ID. 4. VPN gateway ID. 5. The current state of the VPN connection (pending, available, deleting, deleted). 6. The customer gateway configuration information in the native XML format. </summary> <param name="request">Describe Vpn Connections request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpn Connections Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest)"> <summary> Gives you information about your subnets. </summary> <remarks> You can filter the results to return information only about subnets that match criteria you specify. For example, you could ask to get information about a particular subnet (or all) only if the subnet's state is available. You can specify multiple filters (e.g., the subnet is in a particular VPC, and the subnet's state is available). The result includes information for a particular subnet only if the subnet matches all your filters. If there's no match, no special message is returned; the response is simply empty </remarks> <param name="request">Describe Subnets request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Subnets Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest)"> <summary> Detaches a VPN gateway from a VPC. </summary> <remarks> You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a VPN gateway has been completely detached from a VPC by describing the VPN gateway (any attachments to the VPN gateway are also described). You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the VPN gateway. </remarks> <param name="request">Detach Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest)"> <summary> Gives you information about your VPCs. </summary> <remarks> You can filter the results to return information only about VPCs that match criteria you specify. For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if the VPC matches all your filters. If there's no match, no special message is returned; the response is simply empty. The information returned consists of: a) The VPC ID. b) The CIDR block you've assigned to the VPC. c) The ID of the DHCP options you've associated with the VPC (or "default" if the default options are associated with the VPC) The current state of the VPC (pending or available) </remarks> <param name="request">Describe Vpcs request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpcs Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest)"> <summary> Deletes a customer gateway. </summary> <remarks> You must delete the VPN connection before deleting the customer gateway. AWS might delete any customer gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer gateway). </remarks> <param name="request">Delete Customer Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Customer Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest)"> <summary> Attaches a virtual private gateway to a VPC. </summary> <remarks> This is the last step required to get your VPC fully connected to your data center before launching instances in it. </remarks> <param name="request">Attach Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest)"> <summary> Deletes a set of DHCP options that you specify. </summary> <remarks> Amazon VPC returns an error if the set of options you specify is currently associated with a VPC. You can disassociate the set of options by associating either a new set of options or the default options with the VPC. </remarks> <param name="request">Delete Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest)"> <summary> Deletes a subnet from a VPC. </summary> <remarks> You must terminate all running instances in the subnet before deleting it, otherwise Amazon VPC returns an error. AWS might delete any subnet if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet). </remarks> <param name="request">Delete Subnet request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Subnet Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpc(Amazon.EC2.Model.CreateVpcRequest)"> <summary> Creates a VPC with the CIDR block you specify. </summary> <remarks> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /18 netmask (16,384 IP addresses). To help you decide how big to make your VPC, go to the topic about creating VPCs in the Amazon Virtual Private Cloud Developer Guide. By default, each instance you launch in the VPC has the default DHCP options (the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type). AWS might delete any VPC that you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC). </remarks> <param name="request">Create Vpc request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpc Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest)"> <summary> Provides information to AWS about your customer gateway device. </summary> <remarks> The customer gateway is the appliance at your end of the VPN connection (compared to the VPN gateway, which is the device at the AWS side of the VPN connection). AWS might delete any customer gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer 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). For device’s that use Border Gateway Protocal (BGP), you can also provide the device's Border Gateway Protocol (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). Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in US East, and 9059, which is reserved in EU West For more information about ASNs, go to the Wikipedia article - http://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29. </remarks> <param name="request">Create Customer Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Customer Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest)"> <summary> Creates a new VPN gateway. </summary> <remarks> A VPN gateway is the VPC-side endpoint for your VPN connection. You can create a VPN gateway before creating the VPC itself. AWS might delete any VPN gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway) </remarks> <param name="request">Create Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpc(Amazon.EC2.Model.DeleteVpcRequest)"> <summary> Deletes a VPC. </summary> <remarks> You must terminate all running instances and delete all subnets before deleting the VPC, otherwise Amazon VPC returns an error. AWS might delete any VPC if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC). </remarks> <param name="request">Delete Vpc request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpc Response from the service</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 the default DHCP options with the VPC. </summary> <remarks> The default set consists of the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. For more information about the supported DHCP options and using them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual Private Cloud Developer Guide. </remarks> <param name="request">Associate Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Associate Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest)"> <summary> Gives you information about your VPN gateways. </summary> <remarks> You can filter the results to return information only about VPN gateways that match criteria you specify. For example, you could ask to get information about a particular VPN gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the VPN gateway is in a particular Availability Zone and the gateway's state is pending or available). The result includes information for a particular VPN gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN gateway ID - The current state of the VPN gateway (pending, available, deleting, deleted) 2. The type of VPN connection the VPN gateway supports. 3. The Availability Zone where the VPN gateway was created. 4. The VPCs the VPN gateway is attached to and the state of each attachment (attaching, attached, detaching, detached) </remarks> <param name="request">Describe Vpn Gateways request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpn Gateways Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSubnet(Amazon.EC2.Model.CreateSubnetRequest)"> <summary> Creates a subnet in an existing VPC. </summary> <remarks> You can create up to 20 subnets in a VPC. 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. If you feel you need more than 20 subnets, you can request more by going to http://aws.amazon.com/contact-us/vpc-request/. When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. Once 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 /18 netmask (16,384 IP addresses). *Important* AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. AWS might delete any subnet you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet). </remarks> <param name="request">Create Subnet request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Subnet Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest)"> <summary> Deletes a VPN connection. </summary> <remarks> This operation will delete a VPC and all its associated components. Another reason to use this operation is if you believe the tunnel credentials for your VPN connection have been compromised. In that situation, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or VPN 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. If you're deleting the VPC and all its associated parts, we recommend you detach the VPN gateway from the VPC and delete the VPC before deleting the VPN connection. </remarks> <param name="request">Delete Vpn Connection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpn Connection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest)"> <summary> Deletes a VPN gateway. </summary> <remarks> Use this when you want to delete a VPC and all its associated components because you no longer need them. We recommend that before you delete a VPN gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the VPN gateway if you just want to delete and re-create the VPN connection between your VPC and data center. AWS might delete any VPN gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway). </remarks> <param name="request">Delete Vpn Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpn Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest)"> <summary> Returns information about your customer gateways. </summary> <remarks> You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could ask to get information about a particular customer gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the customer gateway has a particular IP address for the Internet-routable external interface, and the gateway's state is pending or available). The result includes information for a particular customer gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty </remarks> <param name="request">Describe Customer Gateways request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Customer Gateways Response from the service</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 ipsec.1. </summary> <remarks> The response includes information that you need to configure your customer gateway, in XML format. It is strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. If you 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 CreateVpnConnection. </remarks> <param name="request">Create Vpn Connection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpn Connection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest)"> <summary> Gives you information about one or more sets of DHCP options. You can specify one or more DHCP options set IDs, or no IDs (to describe all your sets of DHCP options). </summary> <remarks> The returned information consists of: 1. The DHCP options set ID 2. The options </remarks> <param name="request">Describe Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest)"> <summary> <para>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> .</para> <ul> <li> <c>domain-name-servers</c> - The IP addresses of up to four domain name servers, or <c>AmazonProvidedDNS</c> . The default DHCP option set specifies <c>AmazonProvidedDNS</c> . If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <c>domain-name</c> - If you're using AmazonProvidedDNS in <c>us-east-1</c> , specify <c>ec2.internal</c> . If you're using AmazonProvidedDNS in another region, specify <c>region.compute.internal</c> (for example, <c>ap-northeast-1.compute.internal</c> ). Otherwise, specify a domain name (for example, <c>MyCompany.com</c> ).</li> <li> <c>ntp-servers</c> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <c>netbios-name-servers</c> - The IP addresses of up to four NetBIOS name servers.</li> <li> <c>netbios-node-type</c> - 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>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">Create Dhcp Options request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Dhcp Options Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest)"> <summary> Creates a Spot Instance request. </summary> <remarks> Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum 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. </remarks> <param name="request">Request Spot Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Request Spot Instances Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest)"> <summary> Describes the Spot Instance requests that belong to your account. </summary> <remarks> Spot Instances are instances that automatically launch when your request price exceeds that Spot Price that Amazon EC2 periodically calculates. </remarks> <param name="request">Describe Spot Instance Requests request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Spot Instance Requests Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest)"> <summary> Cancels one or more Spot Instance requests. </summary> <remarks> Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum 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. </remarks> <param name="request">Cancel Spot Instance Requests request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Spot Instance Requests Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest)"> <summary> Describes the Spot Price history. </summary> <param name="request">Describe Spot Price History request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Spot Price History Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest)"> <summary> Creates the datafeed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account. </summary> <param name="request">Create Spot Datafeed Subscription request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Spot Datafeed Subscription Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest)"> <summary> Describes the datafeed for Spot Instances. </summary> <param name="request">Describe Spot Datafeed Subscription request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Spot Datafeed Subscription Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest)"> <summary> Deletes the datafeed for Spot Instances. </summary> <param name="request">Delete Spot Datafeed Subscription request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Spot Datafeed Subscription Response from the service</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. </summary> <remarks> The command 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. </remarks> <param name="request">Cancel Conversion Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Conversion Task Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest)"> <summary> Describes your conversion tasks. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide. </summary> <param name="request">Describe Conversion Tasks request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Conversion Tasks Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportInstance(Amazon.EC2.Model.ImportInstanceRequest)"> <summary> <para>Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.</para> </summary> <param name="request">Import Instance request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Import Instance Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportVolume(Amazon.EC2.Model.ImportVolumeRequest)"> <summary> <para>Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume 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> .</para> </summary> <param name="request">Import Volume request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Import Volume Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest)"> <summary> Adds one or more egress rules to a VPC security group. </summary> <remarks> <para> This call permits instances in a security group to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups in the same VPC. </para> <para> This action applies only to security groups in a VPC; it's not supported for standard (EC2) security groups. </para> <para> Each rule consists of the protocol (e.g., 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 as a wildcard for the ICMP type or code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </remarks> <param name="request">Authorize Security Group Egress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Authorize Security Group Egress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest)"> <summary> Removes one or more egress rules from a VPC security group. </summary> <remarks> This action applies only to security groups in a VPC. It doesn't work with standard (EC2) security groups. For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual Private Cloud User Guide. The values that you specify in the revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to be revoked. Each rule consists of the protocol, and the CIDR range or destination 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. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </remarks> <param name="request">Revoke Security Group Egress request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Revoke Security Group Egress Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest)"> <summary> Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway. </summary> <param name="request">Create Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Internet Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest)"> <summary> Gives you information about your Internet gateways. </summary> <remarks> You can filter the results to return information only about Internet gateways that match criteria you specify. For example, you could get information only about gateways with particular tags. The Internet gateway must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged with a particular value). The result includes information for a particular Internet gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> <param name="request">Describe Internet Gateways request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Internet Gateways Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest)"> <summary> Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide. </summary> <param name="request">Delete Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Internet Gateway Response from the service</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. </summary> <param name="request">Attach Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Internet Gateway Response from the service</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. </summary> <remarks> The VPC must not contain any running instances with elastic IP addresses. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Detach Internet Gateway request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Internet Gateway Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest)"> <summary> Creates a route table within a VPC. After you create a new route table, you can add routes and associate the table with a subnet. </summary> <param name="request">Create Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Route Table Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest)"> <summary> Gives you information about your route tables. </summary> <remarks> You can filter the results to return information only about tables that match criteria you specify. For example, you could get information only about a table associated with a particular subnet.You can specify multiple values for the filter. The table must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the table has a particular route, and is associated with a particular subnet). The result includes information for a particular table only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> <param name="request">Describe Route Tables request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Route Tables Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest)"> <summary> Deletes a route table from a VPC. The route table must not be associated with a subnet. You can't delete the main route table. </summary> <param name="request">Delete Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Route Table Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest)"> <summary> Associates a subnet with a route table. </summary> <remarks> 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 if you want to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. </remarks> <param name="request">Associate Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Associate Route Table Response from the service</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. </summary> <remarks> After you execute this action, the subnet uses the routes in the new route table it's associated with. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Route Table Association request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Route Table Association Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest)"> <summary> Disassociates a subnet from a route table. </summary> <remarks> 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, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Disassociate Route Table request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Disassociate Route Table Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRoute(Amazon.EC2.Model.CreateRouteRequest)"> <summary> Creates a new route in a route table within a VPC. The route's target can be either a gateway attached to the VPC or a NAT instance in the VPC. </summary> <remarks> 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 192.0.2.3, and the route table includes the following two routes: 192.0.2.0/24 (goes to some target A) 192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list is more specific, so we use that route to determine where to target the traffic. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Create Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Route Response from the service</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. </summary> <remarks> For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Route Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRoute(Amazon.EC2.Model.DeleteRouteRequest)"> <summary> Deletes a route from a route table in a VPC. </summary> <param name="request">Delete Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Route Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest)"> <summary> Creates a network ACL in a VPC. </summary> <remarks> Network ACLs provide an optional layer of security (on top of security groups) for the instances in your VPC. </remarks> <param name="request">Create Network Acl request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Network Acl Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest)"> <summary> Gives you information about the network ACLs in your VPC. </summary> <remarks> You can filter the results to return information only about ACLs that match criteria you specify. For example, you could get information for only the ACL associated with a particular subnet. The ACL must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an egress entry that denies traffic to a particular port). The result includes information for a particular ACL only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character.You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> <param name="request">Describe Network Acls request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Network Acls Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest)"> <summary> Deletes a network ACL from a VPC. </summary> <remarks> The ACL must not have any subnets associated with it. You can't delete the default network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Delete Network Acl request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Network Acl Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest)"> <summary> Changes which network ACL a subnet is associated with. </summary> <remarks> By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Network Acl Association request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Network Acl Association Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest)"> <summary> Creates an entry (i.e., rule) in a network ACL with a rule number you specify. </summary> <remarks> 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, Amazon VPC processes the entries in the ACL according to the rule numbers, in ascending order. We recommend that you leave room between the rules (e.g., 100, 110, 120, etc.), and not number them sequentially (101, 102, 103, etc.). This allows you to easily add a new rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create a new entry and delete the old one. </remarks> <param name="request">Create Network Acl Entry request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Network Acl Entry Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest)"> <summary> Replaces an entry (i.e., rule) in a network ACL. </summary> <remarks> For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Replace Network Acl Entry request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Replace Network Acl Entry Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest)"> <summary> Deletes an ingress or egress entry (i.e., rule) from a network ACL. </summary> <remarks> For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> <param name="request">Delete Network Acl Entry request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Network Acl Entry Response from the service</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">Attach Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Attach Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest)"> <summary> Creates a network interface in the specified subnet. </summary> <remarks> This action is supported only in Amazon VPC. </remarks> <param name="request">Create Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest)"> <summary> Deletes the specified network interface. </summary> <param name="request">Delete Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest)"> <summary> Describes a Network Interface Attribute. Only one attribute can be specified per call. </summary> <remarks>Only one attribute can be specified per call.</remarks> <param name="request">Describe Network Interface Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Network Interface Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest)"> <summary> Describes one or more Network Interfaces. </summary> <param name="request">Describe Network Interfaces request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Network Interfaces response from the service</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">Detach Network Interface request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Detach Network Interface response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest)"> <summary> Modifies a network interface attribute. Only one attribute can be specified per call. </summary> <remarks>Only one attribute can be specified per call.</remarks> <param name="request">Modify Network Interface Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Network Interface Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest)"> <summary> Reset Network Interface Attribute request </summary> <remarks>Only one attribute can be specified per call.</remarks> <param name="request">Reset Network Interface Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Reset Network Interface Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest)"> <summary> Returns the status of one or more volumes. </summary> <param name="request">Describe Volume Status request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Volume Status response from the service</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">Enable Volume IO request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Enable Volume IO response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest)"> <summary> Modifies a volume attribute. </summary> <param name="request">Modify Volume Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Volume Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest)"> <summary> Describes an attribute of a volume. </summary> <param name="request">Describe Volume Attribute request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Volume Attribute response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest)"> <summary> Assigns one or more secondary private IP addresses to a network interface in Amazon VPC. </summary> <remarks> You can specify one or more specific secondary IP addresses that you want to assign, or you can specify a 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. </remarks> <param name="request">Assign Private Ip Addresses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Assign Private Ip Addresses response from the service</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 in Amazon VPC. This command is only available in Amazon VPC </summary> <param name="request">Unassign Private Ip Addresses request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Unassign Private Ip Addresses response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest)"> <summary> Creates a new 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> <remarks> We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </remarks> <param name="request">Create Vpn Connection Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Vpn Connection Route response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest)"> <summary> Deletes 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. </summary> <remakrs> We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </remakrs> <param name="request">Delete Vpn Connection Route request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Delete Vpn Connection Route response from the service</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 routing tables of an Amazon VPC. </summary> <param name="request">Enable Virtual Gateway Route Propagation request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Enable Virtual Gateway Route Propagation response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisableVGWRoutePropagation(Amazon.EC2.Model.DisableVGWRoutePropagationRequest)"> <summary> Disables a virtual private gateway (VGW) from propagating routes to the routing tables of an Amazon VPC. </summary> <param name="request">Disable Virtual Gateway Route Propagation request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Disable Virtual Gateway Route Propagation response from the service</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. </summary> <param name="request">Cancel Reserved Instances Listing request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Reserved Instances Listing response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest)"> <summary> Creates a new listing for Amazon EC2 Reserved Instances that will be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. </summary> <remarks> 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. If you want 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 you want to receive for them. Your Reserved Instance listings then become available for purchase. </remarks> <param name="request">Create Reserved Instances Listing request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Reserved Instances Listing response from the service</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. </summary> <param name="request">Describe Reserved Instances Listing request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Reserved Instances Listing response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopySnapshot(Amazon.EC2.Model.CopySnapshotRequest)"> <summary> <para>Copies a point-in-time snapshot of an Amazon 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 Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.</para> <para>Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.</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">Copy Snapshot request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Copy Snapshot response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopyImage(Amazon.EC2.Model.CopyImageRequest)"> <summary> <para>Initiates the copy of an AMI from the specified source region to the region in which the request was made. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.</para> <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">Copy Image request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Copy Snapshot response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest)"> <summary> Describes VPC attributes. </summary> <param name="request">Describe Vpc Attributes Request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Vpc Attributes response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest)"> <summary> Modified attributes on a VPC. </summary> <param name="request">Modify Vpc Attributes Request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Vpc Attributes response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest)"> <summary> Describes account attributes of the caller </summary> <param name="request">Describe Account Attributes Request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Account Attributes response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest)"> <summary> Creates a new export task, produces an image of an EC2 instance for use in another virtualization environment, and then writes the image to the specified Amazon S3 bucket. If the instance is running at the time of export, Amazon EC2 will attempt to shut down the instance, initiate the export process, and then reboot the instance. Only instances derived from your own ImportInstance tasks may be exported. When the task is complete, the image can be downloaded from your Amazon S3 bucket. </summary> <param name="request">Create Instance Export Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Create Instance Export Task response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest)"> <summary> Describes your export tasks. If no export task IDs are specified, all export tasks initiated by you are returned. </summary> <param name="request">Describe Export Tasks request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Export Tasks response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest)"> <summary> Cancels an active export task. The command 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">Cancel Export Task request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Cancel Export Task response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest)"> <summary> Describes modifications made to Reserved Instances in your account. </summary> <param name="request">Describe Reserved Instances Modifications request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Describe Reserved Instances Modifications response from the service</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. </summary> <param name="request">Modify Reserved Instances request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>Modify Reserved Instances response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest)"> <summary> <para>Rejects a VPC peering connection request. The VPC peering connection must be in the <c>pending-acceptance</c> state. Use the <c>DescribeVpcPeeringConnections</c> request to view your outstanding VPC peering connection requests.</para> </summary> <param name="request">RejectVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>RejectVpcPeeringConnection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest)"> <summary> <para>Describes one or more of your VPC peering connections.</para> </summary> <param name="request">DescribeVpcPeeringConnections request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>DescribeVpcPeeringConnections Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest)"> <summary> <para>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 <c>active</c> state. The owner of the requester VPC can delete a VPC peering connection in the <c>pending-acceptance</c> state.</para> </summary> <param name="request">DeleteVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>DeleteVpcPeeringConnection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest)"> <summary> <para>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> <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 <c>CreateVpcPeeringConnection</c> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <c>failed</c> .</para> </summary> <param name="request">CreateVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>CreateVpcPeeringConnection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest)"> <summary> <para>Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <c>pending-acceptance</c> state, and you must be the owner of the peer VPC. Use the <c>DescribeVpcPeeringConnections</c> request to view your outstanding VPC peering connection requests.</para> </summary> <param name="request">AcceptVpcPeeringConnection request</param> <exception cref="T:System.Net.WebException"></exception> <exception cref="T:Amazon.EC2.AmazonEC2Exception"></exception> <returns>AcceptVpcPeeringConnection Response from the service</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConfigureWebRequest(System.Int32,Amazon.EC2.AmazonEC2Config)"> Configure HttpClient with set of defaults as well as configuration from AmazonEC2Config instance </member> <member name="M:Amazon.EC2.AmazonEC2Client.Invoke``1(System.Collections.Generic.IDictionary{System.String,System.String})"> Invoke request and return response </member> <member name="M:Amazon.EC2.AmazonEC2Client.Invoke``1(System.Collections.Generic.IDictionary{System.String,System.String},System.Xml.Serialization.XmlElementEventHandler,Amazon.Runtime.ImmutableCredentials)"> Invoke request and return response Allows caller to pass in ImmutableCredentials. This way, if ImmutableCredentials were needed before Invoke, the same credentials will be used in Invoke. unknownElementHandler is passed for types that contain members tagged Obsolete, which would be skipped by the serializer. </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReportAnyErrors(System.String,System.Net.HttpStatusCode,System.Exception)"> Look for additional error strings in the response and return formatted exception </member> <member name="M:Amazon.EC2.AmazonEC2Client.PauseOnRetry(System.Int32,System.Int32,System.Net.HttpStatusCode,System.Exception,System.String)"> Exponential sleep on failed request </member> <member name="M:Amazon.EC2.AmazonEC2Client.AddRequiredParameters(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},Amazon.Runtime.ImmutableCredentials)"> Add authentication related and version parameters </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertBase(Amazon.EC2.Model.EC2Request)"> Convert base EC2Request </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertActivateLicense(Amazon.EC2.Model.ActivateLicenseRequest)"> Convert ActivateLicenseRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAllocateAddress(Amazon.EC2.Model.AllocateAddressRequest)"> Convert AllocateAddressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest)"> Convert AttachVpnGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest)"> Convert AssociateDhcpOptionsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAssociateAddress(Amazon.EC2.Model.AssociateAddressRequest)"> Convert AssociateAddressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest)"> Convert AuthorizeSecurityGroupIngressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertBundleInstance(Amazon.EC2.Model.BundleInstanceRequest)"> Convert BundleInstanceRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest)"> Convert CancelBundleTaskRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest)"> Convert ConfirmProductInstanceRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest)"> Convert CreatePlacementGroupRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateImage(Amazon.EC2.Model.CreateImageRequest)"> Convert CreateImageRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest)"> Convert CreateKeyPairRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest)"> Convert ImportKeyPairRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateTags(Amazon.EC2.Model.CreateTagsRequest)"> Convert CreateTagsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeTags(Amazon.EC2.Model.DescribeTagsRequest)"> Convert DescribeTagsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteTags(Amazon.EC2.Model.DeleteTagsRequest)"> Convert DeleteTagsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateSubnet(Amazon.EC2.Model.CreateSubnetRequest)"> Convert CreateSubnetRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateVpnConnection(Amazon.EC2.Model.CreateVpnConnectionRequest)"> Convert CreateVpnConnectionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest)"> Convert CreateVpnGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest)"> Convert CreateDhcpOptionsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateVpc(Amazon.EC2.Model.CreateVpcRequest)"> Convert CreateVpcRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest)"> Convert CreateCustomerGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest)"> Convert CreateSecurityGroupRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeactivateLicense(Amazon.EC2.Model.DeactivateLicenseRequest)"> Convert DeactivateLicenseRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest)"> Convert DeleteKeyPairRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest)"> Convert DeletePlacementGroupRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteVpc(Amazon.EC2.Model.DeleteVpcRequest)"> Convert DeleteVpcRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest)"> Convert DeleteVpnGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest)"> Convert DeleteVpnConnectionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest)"> Convert DeleteDhcpOptionsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest)"> Convert DeleteCustomerGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest)"> Convert DeleteSecurityGroupRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest)"> Convert DeleteSubnetRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest)"> Convert DescribeVpcsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest)"> Convert DescribeVpnGatewaysRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest)"> Convert DescribeDhcpOptionsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest)"> Convert DescribeVpnConnectionsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest)"> Convert DescribeCustomerGatewaysRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest)"> Convert DescribeReservedInstancesOfferingsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest)"> Convert DescribeReservedInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest)"> Convert DescribeSubnetsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertPurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest)"> Convert PurchaseReservedInstancesOfferingRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeregisterImage(Amazon.EC2.Model.DeregisterImageRequest)"> Convert DeregisterImageRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest)"> Convert DescribeAddressesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest)"> Convert DescribeAvailabilityZonesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest)"> Convert DescribeBundleTasksRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest)"> Convert DescribeImageAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest)"> Convert DescribeInstanceAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest)"> Convert DescribeSnapshotAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeImages(Amazon.EC2.Model.DescribeImagesRequest)"> Convert DescribeImagesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest)"> Convert DescribeInstanceStatusRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest)"> Convert ReportInstanceStatusRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest)"> Convert DescribeInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest)"> Convert DescribeKeyPairsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeLicenses(Amazon.EC2.Model.DescribeLicensesRequest)"> Convert DescribeLicensesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest)"> Convert DescribePlacementGroupsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest)"> Convert DescribeSecurityGroupsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest)"> Convert DisassociateAddressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertGetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest)"> Convert GetConsoleOutputRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertGetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest)"> Convert GetPasswordDataRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest)"> Convert ModifyImageAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest)"> Convert ModifyInstanceAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest)"> Convert ModifySnapshotAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertMonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest)"> Convert MonitorInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertUnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest)"> Convert UnmonitorInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertRebootInstances(Amazon.EC2.Model.RebootInstancesRequest)"> Convert RebootInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertRegisterImage(Amazon.EC2.Model.RegisterImageRequest)"> Convert RegisterImageRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest)"> Convert ReleaseAddressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest)"> Convert ResetImageAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest)"> Convert ResetInstanceAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest)"> Convert ResetSnapshotAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertRevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest)"> Convert RevokeSecurityGroupIngressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertRunInstances(Amazon.EC2.Model.RunInstancesRequest)"> Convert RunInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertStopInstances(Amazon.EC2.Model.StopInstancesRequest)"> Convert StopInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertStartInstances(Amazon.EC2.Model.StartInstancesRequest)"> Convert StartInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertTerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest)"> Convert TerminateInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest)"> Convert DeleteVolumeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateVolume(Amazon.EC2.Model.CreateVolumeRequest)"> Convert CreateVolumeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest)"> Convert DescribeVolumesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDetachVolume(Amazon.EC2.Model.DetachVolumeRequest)"> Convert DetachVolumeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest)"> Convert DetachVpnGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest)"> Convert DescribeSnapshotsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest)"> Convert DeleteSnapshotRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest)"> Convert CreateSnapshotRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAttachVolume(Amazon.EC2.Model.AttachVolumeRequest)"> Convert AttachVolumeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest)"> Convert DescribeRegionsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertRequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest)"> Convert RequestSpotInstancesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest)"> Convert DescribeSpotInstanceRequestsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest)"> Convert CancelSpotInstanceRequestsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest)"> Convert DescribeSpotPriceHistoryRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest)"> Convert CreateSpotDatafeedSubscriptionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest)"> Convert DescribeSpotDatafeedSubscriptionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest)"> Convert DeleteSpotDatafeedSubscriptionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertImportInstance(Amazon.EC2.Model.ImportInstanceRequest)"> Convert ImportInstanceRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertImportVolume(Amazon.EC2.Model.ImportVolumeRequest)"> Convert ImportVolumeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest)"> Convert DescribeConversionTasksRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest)"> Convert CancelConversionTaskRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest)"> Convert AuthorizeSecurityGroupEgressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertRevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest)"> Convert RevokeSecurityGroupEgressRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest)"> Convert CreateInternetGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest)"> Convert DescribeInternetGatewaysRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest)"> Convert DeleteInternetGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest)"> Convert AttachInternetGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest)"> Convert DetachInternetGatewayRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest)"> Convert CreateRouteTableRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest)"> Convert DescribeRouteTablesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest)"> Convert DeleteRouteTableRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest)"> Convert AssociateRouteTableRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest)"> Convert ReplaceRouteTableAssociationRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest)"> Convert DisassociateRouteTableRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateRoute(Amazon.EC2.Model.CreateRouteRequest)"> Convert CreateRouteRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest)"> Convert ReplaceRouteRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteRoute(Amazon.EC2.Model.DeleteRouteRequest)"> Convert DeleteRouteRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest)"> Convert CreateNetworkAclRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest)"> Convert DescribeNetworkAclsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest)"> Convert DeleteNetworkAclRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest)"> Convert ReplaceNetworkAclAssociationRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest)"> Convert CreateNetworkAclEntryRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest)"> Convert ReplaceNetworkAclEntryRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest)"> Convert DeleteNetworkAclEntryRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest)"> Convert AttachNetworkInterfaceRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest)"> Convert CreateNetworkInterfaceRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest)"> Convert DeleteNetworkInterfaceRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest)"> Convert DescribeNetworkInterfaceAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest)"> Convert DescribeNetworkInterfacesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest)"> Convert DetachNetworkInterfaceRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest)"> Convert ModifyNetworkInterfaceAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest)"> Convert ResetNetworkInterfaceAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest)"> Convert DescribeVolumeStatusRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertEnableVolumeIO(Amazon.EC2.Model.EnableVolumeIORequest)"> Convert EnableVolumeIORequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest)"> Convert ModifyVolumeAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest)"> Convert DescribeVolumeAttributeRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest)"> Convert AssignPrivateIpAddresses to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertUnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest)"> Convert UnassignPrivateIpAddresses to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest)"> Convert CreateVpnConnectionRouteRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest)"> Convert DeleteVpnConnectionRouteRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertEnableVGWRoutePropagation(Amazon.EC2.Model.EnableVGWRoutePropagationRequest)"> Convert EnableVGWRoutePropagationRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDisableVGWRoutePropagation(Amazon.EC2.Model.DisableVGWRoutePropagationRequest)"> Convert DisableVGWRoutePropagationRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest)"> Convert CancelReservedInstancesListingRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest)"> Convert CreateReservedInstancesListingRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest)"> Convert DescribeReservedInstancesListingRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCopySnapshot(Amazon.EC2.Model.CopySnapshotRequest)"> Convert CopySnapshotRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCopyImage(Amazon.EC2.Model.CopyImageRequest)"> Convert CopySnapshotRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest)"> Convert DescribeVpcAttributesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest)"> Convert ModifyVpcAttributesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest)"> Convert DescribeAccountAttributesRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest)"> Convert CreateInstanceExportTaskRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest)"> Convert DescribeExportTasksRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest)"> Convert CancelExportTaskRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest)"> Convert DescribeReservedInstancesModifications to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertModifyReservedInstances(Amazon.EC2.Model.ModifyReservedInstancesRequest)"> Convert DescribeReservedInstancesModifications to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertRejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest)"> Convert RejectVpcPeeringConnectionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest)"> Convert DescribeVpcPeeringConnectionsRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertDeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest)"> Convert DeleteVpcPeeringConnectionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertCreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest)"> Convert CreateVpcPeeringConnectionRequest to name value pairs </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConvertAcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest)"> Convert AcceptVpcPeeringConnectionRequest to name value pairs </member> <member name="T:Amazon.EC2.AmazonEC2Config"> <summary> Configuration for accessing Amazon EC2 service </summary> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithSignatureMethod(System.String)"> <summary> Sets the SignatureMethod property </summary> <param name="signatureMethod">SignatureMethod property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetSignatureMethod"> <summary> Checks if SignatureMethod property is set </summary> <returns>true if SignatureMethod property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithSignatureVersion(System.String)"> <summary> Sets the SignatureVersion property </summary> <param name="signatureVersion">SignatureVersion property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetSignatureVersion"> <summary> Checks if SignatureVersion property is set </summary> <returns>true if SignatureVersion property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithUserAgent(System.String)"> <summary> Sets the UserAgent property </summary> <param name="userAgent">UserAgent property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetUserAgent"> <summary> Checks if UserAgent property is set </summary> <returns>true if UserAgent property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithServiceURL(System.String)"> <summary> Sets the ServiceURL property </summary> <param name="serviceURL">ServiceURL property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetServiceURL"> <summary> Checks if ServiceURL property is set </summary> <returns>true if ServiceURL property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithProxyHost(System.String)"> <summary> Sets the ProxyHost property </summary> <param name="proxyHost">ProxyHost property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetProxyHost"> <summary> Checks if ProxyHost property is set </summary> <returns>true if ProxyHost property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithProxyPort(System.Int32)"> <summary> Sets the ProxyPort property </summary> <param name="proxyPort">ProxyPort property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetProxyPort"> <summary> Checks if ProxyPort property is set </summary> <returns>true if ProxyPort property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithProxyCredentials(System.Net.ICredentials)"> <summary> Sets the ProxyCredentials property. </summary> <param name="proxyCredentials">ProxyCredentials property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetProxyCredentials"> <summary> Checks if ProxyCredentials property is set </summary> <returns>true if ProxyCredentials property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithMaxErrorRetry(System.Int32)"> <summary> Sets the MaxErrorRetry property </summary> <param name="maxErrorRetry">MaxErrorRetry property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetMaxErrorRetry"> <summary> Checks if MaxErrorRetry property is set </summary> <returns>true if MaxErrorRetry property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithUseSecureStringForAwsSecretKey(System.Boolean)"> <summary> Sets the UseSecureString property. By default, the AWS Secret Access Key is stored in a SecureString (true) - this is one of the secure ways to store a secret provided by the .NET Framework. But, the use of SecureStrings is not supported in Medium Trust Windows Hosting environments. If you are building an ASP.NET application that needs to run with Medium Trust, set this property to false, and the client will not save your AWS Secret Key in a secure string. Changing the default to false can result in the Secret Key being vulnerable; please use this property judiciously. </summary> <param name="fSecure"> Whether a secure string should be used or not. </param> <returns>The Config object with the property set</returns> <remarks>Storing the AWS Secret Access Key is not recommended unless absolutely necessary. </remarks> <seealso cref="T:System.Security.SecureString"/> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithProxyUsername(System.String)"> <summary> Sets the ProxyUsername property </summary> <param name="userName">Value for the ProxyUsername property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetProxyUsername"> <summary> Checks if ProxyUsername property is set </summary> <returns>true if ProxyUsername property is set</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.WithProxyPassword(System.String)"> <summary> Sets the ProxyPassword property. Used in conjunction with the ProxyUsername property to authenticate requests with the specified Proxy server. </summary> <remarks> If this property isn't set, String.Empty is used as the proxy password. This property isn't used if ProxyUsername is null or empty. </remarks> <param name="password">ProxyPassword property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Config.IsSetProxyPassword"> <summary> Checks if ProxyPassword property is set </summary> <returns>true if ProxyPassword property is set</returns> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ServiceVersion"> <summary> Gets Service Version </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.SignatureMethod"> <summary> Gets and sets of the signatureMethod property. </summary> <remarks> This property is ignored; the AmazonEC2Client in the SDK uses AWS Signature Version 4 for all regions. </remarks> </member> <member name="P:Amazon.EC2.AmazonEC2Config.SignatureVersion"> <summary> Gets and sets of the SignatureVersion property. </summary> <remarks> This property is ignored; the AmazonEC2Client in the SDK uses AWS Signature Version 4 for all regions. </remarks> </member> <member name="P:Amazon.EC2.AmazonEC2Config.UserAgent"> <summary> Gets and sets of the UserAgent property. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.RegionEndpoint"> <summary> Gets and sets the RegionEndpoint property. The region constant to use that determines the endpoint to use. If this is not set then the client will fallback to the value of ServiceURL. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ServiceURL"> <summary> Gets and sets of the ServiceURL property. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ProxyHost"> <summary> Gets and sets of the ProxyHost property. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ProxyPort"> <summary> Gets and sets of the ProxyPort property. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ProxyCredentials"> <summary> Credentials to use with a proxy. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.MaxErrorRetry"> <summary> Gets and sets of the MaxErrorRetry property. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.UseSecureStringForAwsSecretKey"> <summary> Gets and Sets the UseSecureStringForAwsSecretKey property. By default, the AWS Secret Access Key is stored in a SecureString (true) - this is one of the secure ways to store a secret provided by the .NET Framework. But, the use of SecureStrings is not supported in Medium Trust Windows Hosting environments. If you are building an ASP.NET application that needs to run with Medium Trust, set this property to false, and the client will not save your AWS Secret Key in a secure string. Changing the default to false can result in the Secret Key being vulnerable; please use this property judiciously. </summary> <remarks>Storing the AWS Secret Access Key is not recommended unless absolutely necessary. </remarks> <seealso cref="T:System.Security.SecureString"/> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ProxyUsername"> <summary> Gets and sets the ProxyUsername property. Used in conjunction with the ProxyPassword property to authenticate requests with the specified Proxy server. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ProxyPassword"> <summary> Gets and sets the ProxyPassword property. Used in conjunction with the ProxyUsername property to authenticate requests with the specified Proxy server. </summary> <remarks> If this property isn't set, String.Empty is used as the proxy password. This property isn't used if ProxyUsername is null or empty. </remarks> </member> <member name="P:Amazon.EC2.AmazonEC2Config.ConnectionLimit"> <summary> Gets and sets the connection limit set on the ServicePoint for the WebRequest. Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in which case ServicePointManager.DefaultConnectionLimit will be used as the default. </summary> </member> <member name="T:Amazon.EC2.AmazonEC2Exception"> <summary> Amazon EC2 Exception provides details of errors returned by Amazon EC2 service </summary> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor"> <summary> Initializes a new AmazonEC2Exception with default values. </summary> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor(System.String)"> <summary> Initializes a new AmazonEC2Exception with a specified error message </summary> <param name="message">A message that describes the error</param> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor(System.String,System.Net.HttpStatusCode)"> <summary> Initializes a new AmazonEC2Exception with a specified error message and HTTP status code </summary> <param name="message">A message that describes the error</param> <param name="statusCode">HTTP status code for error response</param> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor(System.String,System.Net.HttpStatusCode,System.Exception)"> <summary> Initializes a new AmazonEC2Exception with a specified error message and HTTP status code </summary> <param name="message">A message that describes the error</param> <param name="statusCode">HTTP status code for error response</param> <param name="innerException">The nested exception that caused the AmazonS3Exception</param> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor(System.Exception)"> <summary> Initializes a new AmazonEC2Exception from the inner exception that is the cause of this exception. </summary> <param name="innerException">The nested exception that caused the AmazonEC2Exception</param> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Initializes a new AmazonEC2Exception with serialized data. </summary> <param name="info">The object that holds the serialized object data. </param> <param name="context">The contextual information about the source or destination. </param> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Serializes this instance of AmazonEC2Exception. </summary> <param name="info">The object that holds the serialized object data.</param> <param name="context">The contextual information about the source or destination. </param> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor(System.String,System.Exception)"> <summary> Constructs AmazonEC2Exception with message and wrapped exception </summary> <param name="message">A message that describes the error</param> <param name="innerException">The nested exception that caused the AmazonS3Exception</param> </member> <member name="M:Amazon.EC2.AmazonEC2Exception.#ctor(System.String,System.Net.HttpStatusCode,System.String,System.String,System.String,System.String)"> <summary> Initializes an AmazonEC2Exception with error information provided in an AmazonEC2 response. </summary> <param name="message">A message that describes the error</param> <param name="statusCode">HTTP status code for error response</param> <param name="errorCode">Error Code returned by the service</param> <param name="errorType">Error type. Possible types: Sender, Receiver or Unknown</param> <param name="requestId">Request ID returned by the service</param> <param name="xml">Compete xml found in response</param> </member> <member name="P:Amazon.EC2.AmazonEC2Exception.ErrorCode"> <summary> Gets and sets of the ErrorCode property. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Exception.ErrorType"> <summary> Gets and sets of the ErrorType property. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Exception.Message"> <summary> Gets error message </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Exception.StatusCode"> <summary> Gets status code returned by the service if available. If status code is set to -1, it means that status code was unavailable at the time exception was thrown </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Exception.XML"> <summary> Gets XML returned by the service if available. </summary> </member> <member name="P:Amazon.EC2.AmazonEC2Exception.RequestId"> <summary> Gets Request ID returned by the service if available. </summary> </member> <member name="T:Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest"> <summary> Container for the parameters to the AcceptVpcPeeringConnection operation. <para>Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <c>pending-acceptance</c> state, and you must be the owner of the peer VPC. Use the <c>DescribeVpcPeeringConnections</c> request to view your outstanding VPC peering connection requests.</para> </summary> </member> <member name="T:Amazon.EC2.Model.EC2Request"> <summary> Base class for EC2 operation requests. </summary> </member> <member name="M:Amazon.EC2.Model.EC2Request.IsSetIsDryRun"> <summary> Checks if IsDryRun property is set </summary> <returns>true if IsDryRun property is set</returns> </member> <member name="P:Amazon.EC2.Model.EC2Request.IsDryRun"> <summary> Flag that signals that this request should be a dry-run. The service call then checks whether you have the required permissions for the action, without actually making the request. </summary> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest.WithVpcPeeringConnectionId(System.String)"> <summary> Sets the VpcPeeringConnectionId <param name="vpcPeeringConnectionId">The VpcPeeringConnectionId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest.IsSetVpcPeeringConnectionId"> <summary> Checks if VpcPeeringConnectionId is set </summary> <returns>true if VpcPeeringConnectionId property is set</returns> </member> <member name="P:Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest.VpcPeeringConnectionId"> <summary> The ID of the VPC peering connection. </summary> </member> <member name="T:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse"> <summary> The Response for the AcceptVpcPeeringConnection operation. </summary> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse.IsSetAcceptVpcPeeringConnectionResult"> <summary> Checks if AcceptVpcPeeringConnectionResult property is set </summary> <returns>true if AcceptVpcPeeringConnectionResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse.AcceptVpcPeeringConnectionResult"> <summary> Gets and sets the AcceptVpcPeeringConnectionResult property. </summary> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionResult.WithVpcPeeringConnection(Amazon.EC2.Model.VpcPeeringConnection)"> <summary> Sets the VpcPeeringConnection <param name="vpcPeeringConnection">The VpcPeeringConnection.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AcceptVpcPeeringConnectionResult.IsSetVpcPeeringConnection"> <summary> Checks if VpcPeeringConnection is set </summary> <returns>true if VpcPeeringConnection property is set</returns> </member> <member name="P:Amazon.EC2.Model.AcceptVpcPeeringConnectionResult.VpcPeeringConnection"> <summary> Information about the VPC peering connection. </summary> </member> <member name="T:Amazon.EC2.Model.AccountAttribute"> <summary> Account attribute description </summary> </member> <member name="M:Amazon.EC2.Model.AccountAttribute.WithAttributeName(System.String)"> <summary> Sets the name of the attribute. </summary> <param name="attributeName">Name of the attribute.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AccountAttribute.IsSetAttributeName"> <summary> Checks if AttributeName property is set </summary> <returns>true if AttributeName property is set</returns> </member> <member name="M:Amazon.EC2.Model.AccountAttribute.WithAttributeValues(Amazon.EC2.Model.AccountAttributeValue[])"> <summary> Sets the attribute values </summary> <param name="list">Attribute values</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AccountAttribute.IsSetAttributeValues"> <summary> Checks if AttributeValues property is set </summary> <returns>true if AttributeValues property is set</returns> </member> <member name="P:Amazon.EC2.Model.AccountAttribute.AttributeName"> <summary> Name of the attribute. </summary> </member> <member name="P:Amazon.EC2.Model.AccountAttribute.AttributeValues"> <summary> Attribute values </summary> </member> <member name="T:Amazon.EC2.Model.AccountAttributeName"> <summary> Name of an attribute account </summary> </member> <member name="M:Amazon.EC2.Model.AccountAttributeName.WithAttributeName(System.String)"> <summary> Sets the name of the attribute. </summary> <param name="attributeName">Name of the attribute.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AccountAttributeName.IsSetAttributeName"> <summary> Checks if AttributeName property is set </summary> <returns>true if AttributeName property is set</returns> </member> <member name="P:Amazon.EC2.Model.AccountAttributeName.AttributeName"> <summary> Name of the attribute. </summary> </member> <member name="M:Amazon.EC2.Model.AccountAttributeValue.WithAttributeValue(System.String)"> <summary> Sets the value of the attribute. </summary> <param name="attributeValue">Value of the attribute.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AccountAttributeValue.IsSetAttributeValue"> <summary> Checks if AttributeValue property is set </summary> <returns>true if AttributeValue property is set</returns> </member> <member name="P:Amazon.EC2.Model.AccountAttributeValue.AttributeValue"> <summary> Value of the attribute. </summary> </member> <member name="T:Amazon.EC2.Model.ActivateLicenseRequest"> <summary> Activates a specific number of licenses for a 90-day period. Activations can be done against a specific license ID. </summary> </member> <member name="M:Amazon.EC2.Model.ActivateLicenseRequest.WithLicenseId(System.String)"> <summary> Sets the ID for the specific license to activate against. </summary> <param name="licenseId">Specifies the ID for the specific license to activate against.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ActivateLicenseRequest.IsSetLicenseId"> <summary> Checks if LicenseId property is set </summary> <returns>true if LicenseId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ActivateLicenseRequest.WithCapacity(System.Decimal)"> <summary> Sets the additional number of licenses to activate. </summary> <param name="capacity">Specifies the additional number of licenses to activate.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ActivateLicenseRequest.IsSetCapacity"> <summary> Checks if Capacity property is set </summary> <returns>true if Capacity property is set</returns> </member> <member name="P:Amazon.EC2.Model.ActivateLicenseRequest.LicenseId"> <summary> The ID for the specific license to activate against. </summary> </member> <member name="P:Amazon.EC2.Model.ActivateLicenseRequest.Capacity"> <summary> The additional number of licenses to activate. </summary> </member> <member name="T:Amazon.EC2.Model.ActivateLicenseResponse"> <summary> Activates a license. </summary> </member> <member name="M:Amazon.EC2.Model.ActivateLicenseResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ActivateLicenseResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ActivateLicenseResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ActivateLicenseResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.Address"> <summary> A static public IP address designed for dynamic cloud computing. Any elastic IP addresses that you associate with your account remains associated with your account until you explicitly release them. Unlike traditional static IP addresses, however, elastic IP addresses allow you to mask instance or Availability Zone failures by rapidly remapping your public IP addresses to any instance in your account. The Address type contains an Elastic IP associated with your account and the InstanceId of the instance it is associated with. </summary> </member> <member name="M:Amazon.EC2.Model.Address.WithInstanceId(System.String)"> <summary> Sets the ID of the instance. </summary> <param name="instanceId">The ID of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Address.WithPublicIp(System.String)"> <summary> Sets the public IP address. </summary> <param name="publicIp">The public IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetPublicIp"> <summary> Checks if PublicIp property is set </summary> <returns>true if PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.Address.WithAllocationId(System.String)"> <summary> Sets the ID representing the allocation of the address for use with Amazon VPC </summary> <param name="allocationId">The ID representing the allocation of the address for use with Amazon VPC</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetAllocationId"> <summary> Checks if AllocationId property is set </summary> <returns>true if AllocationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Address.WithAssociationId(System.String)"> <summary> Sets the ID representing the association of a VPC elastic IP address with an instance in a VPC. </summary> <param name="associationId">The ID representing the association of a VPC elastic IP address with an instance in a VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetAssociationId"> <summary> Checks if AssociationId property is set </summary> <returns>true if AssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Address.WithDomain(System.String)"> <summary> Sets the domain of the address. </summary> <param name="domain">Whether this elastic IP address is for instances in EC2 (i.e., standard) or Amazon VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetDomain"> <summary> Checks if Domain property is set </summary> <returns>true if Domain property is set</returns> </member> <member name="M:Amazon.EC2.Model.Address.WithNetworkInterfaceId(System.String)"> <summary> Sets the network interface (if any) that the address is associated with (for VPC addresses only). </summary> <param name="networkInterfaceId">Network interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Address.WithNetworkInterfaceOwnerId(System.String)"> <summary> Sets the owner ID. </summary> <param name="networkInterfaceOwnerId">Network interface owner ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetNetworkInterfaceOwnerId"> <summary> Checks if the NetworkInterfaceOwnerId property is set </summary> <returns>true if the NetworkInterfaceOwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Address.WithPrivateIpAddress(System.String)"> <summary> Sets the private IP address associated with the Elastic IP address (for VPC addresses only). </summary> <param name="privateIpAddress">Private IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Address.IsSetPrivateIpAddress"> <summary> Checks if the PrivateIpAddress property is set </summary> <returns>true if the PrivateIpAddress property is set</returns> </member> <member name="P:Amazon.EC2.Model.Address.InstanceId"> <summary> The ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.Address.PublicIp"> <summary> The public IP address. </summary> </member> <member name="P:Amazon.EC2.Model.Address.AllocationId"> <summary> The ID representing the allocation of the address for use with Amazon VPC </summary> </member> <member name="P:Amazon.EC2.Model.Address.AssociationId"> <summary> The ID representing the association of a VPC elastic IP address with an instance in a VPC. </summary> </member> <member name="P:Amazon.EC2.Model.Address.Domain"> <summary> The domain of the address: either "standard" or "vpc" for VPC addresses. </summary> </member> <member name="P:Amazon.EC2.Model.Address.NetworkInterfaceId"> <summary> The network interface (if any) that the address is associated with (for VPC addresses only). </summary> </member> <member name="P:Amazon.EC2.Model.Address.NetworkInterfaceOwnerId"> <summary> The owner ID. </summary> </member> <member name="P:Amazon.EC2.Model.Address.PrivateIpAddress"> <summary> The private IP address associated with the Elastic IP address (for VPC addresses only). </summary> </member> <member name="T:Amazon.EC2.Model.AllocateAddressRequest"> <summary> Acquires an elastic IP address for use with your account or your VPC. </summary> </member> <member name="M:Amazon.EC2.Model.AllocateAddressRequest.WithDomain(System.String)"> <summary> Sets the domain of the address. </summary> <param name="domain">The domain of the address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressRequest.IsSetDomain"> <summary> Checks if Domain property is set </summary> <returns>true if Domain property is set</returns> </member> <member name="P:Amazon.EC2.Model.AllocateAddressRequest.Domain"> <summary> The domain of the address. Set to vpc to allocate the address to your VPC. Default: Address is standard (allocated to EC2) Valid Values: vpc | standard Condition: Required when allocating an address to a VPC </summary> </member> <member name="T:Amazon.EC2.Model.AllocateAddressResponse"> <summary> Allocate Address Response </summary> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResponse.IsSetAllocateAddressResult"> <summary> Checks if AllocateAddressResult property is set </summary> <returns>true if AllocateAddressResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResponse.AllocateAddressResult"> <summary> Gets and sets the AllocateAddressResult property. Allocate Address Result </summary> </member> <member name="T:Amazon.EC2.Model.AllocateAddressResult"> <summary> Allocate Address Result </summary> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResult.IsSetDomain"> <summary> Checks if Domain property is set </summary> <returns>true if Domain property is set</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResult.IsSetAllocationId"> <summary> Checks if AllocationId property is set </summary> <returns>true if AllocationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResult.IsSetPublicIp"> <summary> Checks if PublicIp property is set </summary> <returns>true if PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AllocateAddressResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResult.Domain"> <summary> Gets and sets the Domain property. Whether this elastic IP address is for instances in EC2 (i.e., standard) or instances in a VPC. </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResult.AllocationId"> <summary> Gets and sets the AllocationId property. ID that AWS assigns to represent the allocation of the address for use with Amazon VPC. Returned only for VPC elastic IP addresses. </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResult.PublicIp"> <summary> Gets and sets the PublicIp property. IP address for use with your account. </summary> </member> <member name="T:Amazon.EC2.Model.AssignPrivateIpAddressesRequest"> <summary> Assigns one or more secondary private IP addresses to a network interface in Amazon VPC. </summary> <remarks> You can specify one or more specific secondary IP addresses that you want to assign, or you can specify a 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. </remarks> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the network interface to which the IP address will be assigned. </summary> <param name="networkInterfaceId">Network interface ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.WithSecondaryPrivateIpAddressCount(System.Int32)"> <summary> Sets the number of secondary IP addresses to assign to the network interface. You cannot specify this parameter when also specifying multiple PrivateIPAddresses for the same network interface. </summary> <param name="secondaryPrivateIpAddressCount">Instance Network Interface Association.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.IsSetSecondaryPrivateIpAddressCount"> <summary> Checks if the SecondaryPrivateIpAddressCount property is set </summary> <returns>true if the SecondaryPrivateIpAddressCount property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.WithAllowReassignment(System.Boolean)"> <summary> Sets whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. </summary> <param name="allowReassignment">Whether reassignment is allowed.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.IsSetAllowReassignment"> <summary> Checks if the AllowReassignment property is set </summary> <returns>true if the AllowReassignment property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.WithPrivateIpAddresses(System.String[])"> <summary> Sets the specified IP addresses as secondary IP address to the network interface. </summary> <param name="privateIpAddresses">List of private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.IsSetPrivateIpAddresses"> <summary> Checks if the PrivateIpAddresses property is set </summary> <returns>true if the PrivateIpAddresses property is set</returns> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.NetworkInterfaceId"> <summary> The network interface to which the IP address will be assigned. </summary> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.SecondaryPrivateIpAddressCount"> <summary> The number of secondary IP addresses to assign to the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.AllowReassignment"> <summary> Specifies whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. </summary> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.PrivateIpAddresses"> <summary> Assigns the specified IP addresses as secondary IP address to the network interface. </summary> </member> <member name="T:Amazon.EC2.Model.AssignPrivateIpAddressesResponse"> <summary> Assign Private Ip Addresses Response </summary> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AssignPrivateIpAddressesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.AssociateAddressRequest"> <summary> Associates an elastic IP address with an instance. If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. </summary> <remarks> This is an idempotent operation. If you call it more than once, Amazon EC2 does not return an error. </remarks> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.WithInstanceId(System.String)"> <summary> Sets the instance to associate with the IP address. </summary> <param name="instanceId">The instance to associate with the IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.WithPublicIp(System.String)"> <summary> Sets the Elastic IP address to assign to the instance. </summary> <param name="publicIp">IP address that you are assigning to the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.IsSetPublicIp"> <summary> Checks if PublicIp property is set </summary> <returns>true if PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.WithAllocationId(System.String)"> <summary> Sets the allocation ID for use with Amazon VPC. </summary> <param name="allocationId">The allocation ID that AWS returned when you allocated the elastic IP address for use with Amazon VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.IsSetAllocationId"> <summary> Checks if AllocationId property is set </summary> <returns>true if AllocationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the network interface ID to associate with an instance. </summary> <param name="networkInterfaceId">Network interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.WithPrivateIpAddress(System.String)"> <summary> Sets the primary or secondary private IP address to associate with the Elastic IP address. </summary> <param name="privateIpAddress">Private IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.IsSetPrivateIpAddress"> <summary> Checks if the PrivateIpAddress property is set </summary> <returns>true if the PrivateIpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.WithAllowReassociation(System.Boolean)"> <summary> Sets whether to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface. </summary> <param name="allowReassociation">Whether reassociation is allowed.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.IsSetAllowReassociation"> <summary> Checks if the AllowReassociation property is set </summary> <returns>true if the AllowReassociation property is set</returns> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.InstanceId"> <summary> The instance to associate with the IP address. </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.PublicIp"> <summary> The Elastic IP address to assign to the instance. </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.AllocationId"> <summary> The allocation ID that AWS returned when you allocated the elastic IP address for use with Amazon VPC. Condition: Required for VPC elastic IP addresses </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.NetworkInterfaceId"> <summary> The network interface ID to associate with an instance. Association fails when specifying an instance ID unless exactly one interface is attached. </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.PrivateIpAddress"> <summary> The primary or secondary private IP address to associate with the Elastic IP address. If no private IP is specified, the Elastic IP address is associated with the primary private IP address. This is only available in Amazon VPC. </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.AllowReassociation"> <summary> Specify whether to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface. If the Elastic IP address is associated, and this option is not specified, the operation will fail. This is only available in Amazon VPC. </summary> </member> <member name="T:Amazon.EC2.Model.AssociateAddressResponse"> <summary> Associate Address Response </summary> </member> <member name="M:Amazon.EC2.Model.AssociateAddressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressResponse.IsSetAssociateAddressResult"> <summary> Checks if AssociateAddressResult property is set </summary> <returns>true if AssociateAddressResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AssociateAddressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressResponse.AssociateAddressResult"> <summary> Gets and sets the AssociateAddressResult property. AssociateAddress Result </summary> </member> <member name="T:Amazon.EC2.Model.AssociateAddressResult"> <summary> AssociateAddress Result </summary> </member> <member name="M:Amazon.EC2.Model.AssociateAddressResult.IsSetAssociationId"> <summary> Checks if AssociationId property is set </summary> <returns>true if AssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AssociateAddressResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AssociateAddressResult.AssociationId"> <summary> Gets and sets the AssociationId property. ID that AWS provides to represent the association of the address with an instance. Returned only for VPC elastic IP addresses. </summary> </member> <member name="T:Amazon.EC2.Model.AssociateDhcpOptionsRequest"> <summary> Associates a set of DHCP options (that you've previously created) with the specified VPC. Or, associates the default DHCP options with the VPC. </summary> <remarks> The default set consists of the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type. After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. For more information about the supported DHCP options and using them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual Private Cloud Developer Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsRequest.WithDhcpOptionsId(System.String)"> <summary> Sets the ID of the DHCP options you want to associate with the VPC. </summary> <param name="dhcpOptionsId">The ID of the DHCP options you want to associate with the VPC, or "default" if you want to associate the default DHCP options with the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsRequest.IsSetDhcpOptionsId"> <summary> Checks if DhcpOptionsId property is set </summary> <returns>true if DhcpOptionsId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC you want to associate the DHCP options with. </summary> <param name="vpcId">The ID of the VPC you want to associate the DHCP options with.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.AssociateDhcpOptionsRequest.DhcpOptionsId"> <summary> The ID of the DHCP options you want to associate with the VPC, or "default" if you want to associate the default DHCP options with the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.AssociateDhcpOptionsRequest.VpcId"> <summary> The ID of the VPC you want to associate the DHCP options with. </summary> </member> <member name="T:Amazon.EC2.Model.AssociateDhcpOptionsResponse"> <summary> Associate Dhcp Options Response </summary> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AssociateDhcpOptionsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.AssociateRouteTableRequest"> <summary> Associates a subnet with a route table. </summary> <remarks> 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 if you want to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. </remarks> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableRequest.WithRouteTableId(System.String)"> <summary> Sets the ID of the route table. </summary> <param name="routeTableId">The ID of the route table.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableRequest.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableRequest.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet. </summary> <param name="subnetId">The ID of the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableRequest.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableRequest.RouteTableId"> <summary> The ID of the route table. </summary> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableRequest.SubnetId"> <summary> The ID of the subnet. </summary> </member> <member name="T:Amazon.EC2.Model.AssociateRouteTableResponse"> <summary> The Response for the AssociateRouteTable operation. </summary> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableResponse.IsSetAssociateRouteTableResult"> <summary> Checks if AssociateRouteTableResult property is set </summary> <returns>true if AssociateRouteTableResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableResponse.AssociateRouteTableResult"> <summary> Gets and sets the AssociateRouteTableResult property. AssociateRouteTable Result </summary> </member> <member name="T:Amazon.EC2.Model.AssociateRouteTableResult"> <summary> AssociateRouteTable Result </summary> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableResult.IsSetAssociationId"> <summary> Checks if AssociationId property is set </summary> <returns>true if AssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AssociateRouteTableResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableResult.AssociationId"> <summary> Gets and sets the AssociationId property. ID that AWS provides to represent the association of the route table and the subnet. </summary> </member> <member name="T:Amazon.EC2.Model.AttachInternetGatewayRequest"> <summary> Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. </summary> </member> <member name="M:Amazon.EC2.Model.AttachInternetGatewayRequest.WithInternetGatewayId(System.String)"> <summary> Sets the ID of the Internet gateway to attach. </summary> <param name="internetGatewayId">The ID of the Internet gateway to attach.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachInternetGatewayRequest.IsSetInternetGatewayId"> <summary> Checks if InternetGatewayId property is set </summary> <returns>true if InternetGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachInternetGatewayRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC. </summary> <param name="vpcId">The ID of the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachInternetGatewayRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.AttachInternetGatewayRequest.InternetGatewayId"> <summary> The ID of the Internet gateway to attach. </summary> </member> <member name="P:Amazon.EC2.Model.AttachInternetGatewayRequest.VpcId"> <summary> The ID of the VPC. </summary> </member> <member name="T:Amazon.EC2.Model.AttachInternetGatewayResponse"> <summary> The Response for the AttachInternetGateway operation. </summary> </member> <member name="M:Amazon.EC2.Model.AttachInternetGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachInternetGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AttachInternetGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AttachInternetGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.Attachment"> <summary> Volume Attachment </summary> </member> <member name="M:Amazon.EC2.Model.Attachment.WithVolumeId(System.String)"> <summary> Sets the VolumeId property </summary> <param name="volumeId">The ID of the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The ID of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.WithDevice(System.String)"> <summary> Sets the Device property </summary> <param name="device">Specifies how the device is exposed to the instance (e.g., /dev/sdh).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.IsSetDevice"> <summary> Checks if Device property is set </summary> <returns>true if Device property is set</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">Attachment state. Valid Values: attaching | attached | detaching | detached</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.WithAttachTime(System.String)"> <summary> Sets the AttachTime property </summary> <param name="attachTime">Time stamp when the association was created.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.IsSetAttachTime"> <summary> Checks if AttachTime property is set </summary> <returns>true if AttachTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.WithDeleteOnTermination(System.Boolean)"> <summary> Sets the DeleteOnTermination property </summary> <param name="deleteOnTermination">Determines whether the EBS block device is deleted on instance termination.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Attachment.IsSetDeleteOnTermination"> <summary> Checks if DeleteOnTermination property is set </summary> <returns>true if DeleteOnTermination property is set</returns> </member> <member name="P:Amazon.EC2.Model.Attachment.VolumeId"> <summary> Gets and sets the VolumeId property. The ID of the volume. </summary> </member> <member name="P:Amazon.EC2.Model.Attachment.InstanceId"> <summary> Gets and sets the InstanceId property. The ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.Attachment.Device"> <summary> Gets and sets the Device property. Specifies how the device is exposed to the instance (e.g., /dev/sdh). </summary> </member> <member name="P:Amazon.EC2.Model.Attachment.Status"> <summary> Gets and sets the Status property. Attachment state. Valid Values: attaching | attached | detaching | detached </summary> </member> <member name="P:Amazon.EC2.Model.Attachment.AttachTime"> <summary> Gets and sets the AttachTime property. Time stamp when the association was created. </summary> </member> <member name="P:Amazon.EC2.Model.Attachment.DeleteOnTermination"> <summary> Gets and sets the DeleteOnTermination property. Determines whether the EBS block device is deleted on instance termination. </summary> </member> <member name="T:Amazon.EC2.Model.AttachNetworkInterfaceRequest"> <summary> Attaches a network interface to an instance. </summary> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface to attach. </summary> <param name="interfaceId">The network interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceRequest.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance to attach to the network interface. </summary> <param name="instanceId">The instance ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceRequest.IsSetInstanceId"> <summary> Checks if the InstanceId property is set </summary> <returns>true if the InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceRequest.WithDeviceIndex(System.Int32)"> <summary> Sets the index of the device for the network interface attachment on the instance. </summary> <param name="deviceIndex">The device index</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceRequest.IsSetDeviceIndex"> <summary> Checks if the DeviceIndex property is set </summary> <returns>true if the DeviceIndex property is set</returns> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceRequest.NetworkInterfaceId"> <summary> The ID of the network interface to attach. </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceRequest.InstanceId"> <summary> The ID of the instance to attach to the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceRequest.DeviceIndex"> <summary> The index of the device for the network interface attachment on the instance. </summary> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceResponse.IsSetAttachNetworkInterfaceResult"> <summary> Checks if AttachNetworkInterfaceResult property is set </summary> <returns>true if AttachNetworkInterfaceResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceResponse.AttachNetworkInterfaceResult"> <summary> Gets and sets the AttachNetworkInterfaceResult property. </summary> </member> <member name="T:Amazon.EC2.Model.AttachNetworkInterfaceResult"> <summary> Attach Network Interface result. </summary> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceResult.IsSetAttachmentId"> <summary> Checks if the AttachmentId property is set </summary> <returns>true if the AttachmentId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AttachNetworkInterfaceResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceResult.AttachmentId"> <summary> Gets and sets the ID of the attachment </summary> </member> <member name="T:Amazon.EC2.Model.AttachVolumeRequest"> <summary> Container for the parameters to the AttachVolume operation. <para>Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.</para> <para>Encrypted Amazon 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 Amazon EBS Volume to an Instance</a> . Any device names that aren't reserved for instance store volumes can be used for Amazon 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 only be attached as the root device of a stopped instance.</li> <li>You must be subscribed to the AWS Marketplace code that is on the volume.</li> <li>The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> </ul> <para>For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000" >https://aws.amazon.com/marketplace/help/200900000</a> . For more information about how to use the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace" >AWS Marketplace</a> .</para> <para>For more information about Amazon 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> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.WithVolumeId(System.String)"> <summary> Sets the ID of the Amazon EBS volume. </summary> <param name="volumeId">The ID of the Amazon EBS volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance to which the volume attaches. </summary> <param name="instanceId">The ID of the instance to which the volume attaches.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.WithDevice(System.String)"> <summary> Sets the device name as exposed to the instance (e.g., /dev/sdh, or xvdh). </summary> <param name="device">Specifies how the device is exposed to the instance (e.g., /dev/sdh).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.IsSetDevice"> <summary> Checks if Device property is set </summary> <returns>true if Device property is set</returns> </member> <member name="P:Amazon.EC2.Model.AttachVolumeRequest.VolumeId"> <summary> The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone and the instance must be running. </summary> </member> <member name="P:Amazon.EC2.Model.AttachVolumeRequest.InstanceId"> <summary> The ID of the instance to which the volume attaches. The volume and instance must be within the same Availability Zone and the instance must be running. </summary> </member> <member name="P:Amazon.EC2.Model.AttachVolumeRequest.Device"> <summary> The device name as exposed to the instance (e.g., /dev/sdh, or xvdh). </summary> </member> <member name="T:Amazon.EC2.Model.AttachVolumeResponse"> <summary> Attach Volume Response </summary> </member> <member name="M:Amazon.EC2.Model.AttachVolumeResponse.IsSetAttachVolumeResult"> <summary> Checks if AttachVolumeResult property is set </summary> <returns>true if AttachVolumeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AttachVolumeResponse.AttachVolumeResult"> <summary> Gets and sets the AttachVolumeResult property. Attach Volume Result </summary> </member> <member name="P:Amazon.EC2.Model.AttachVolumeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.AttachVolumeResult"> <summary> Attach Volume Result </summary> </member> <member name="M:Amazon.EC2.Model.AttachVolumeResult.IsSetAttachment"> <summary> Checks if Attachment property is set </summary> <returns>true if Attachment property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AttachVolumeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AttachVolumeResult.Attachment"> <summary> Gets and sets the Attachment property. Volume Attachment </summary> </member> <member name="T:Amazon.EC2.Model.AttachVpnGatewayRequest"> <summary> Attaches a virtual private gateway to a VPC. </summary> <remarks> This is the last step required to get your VPC fully connected to your data center before launching instances in it. </remarks> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayRequest.WithVpnGatewayId(System.String)"> <summary> Sets the ID of the virtual private gateway you want to attach to the VPC. </summary> <param name="vpnGatewayId">The ID of the virtual private gateway you want to attach to the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayRequest.IsSetVpnGatewayId"> <summary> Checks if VpnGatewayId property is set </summary> <returns>true if VpnGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC you want to attach to the virtual private gateway </summary> <param name="vpcId">The ID of the VPC you want to attach to the VPN gateway</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayRequest.VpnGatewayId"> <summary> The ID of the virtual private gateway you want to attach to the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayRequest.VpcId"> <summary> The ID of the VPC you want to attach to the virtual private gateway </summary> </member> <member name="T:Amazon.EC2.Model.AttachVpnGatewayResponse"> <summary> Attach Vpn Gateway Response </summary> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayResponse.IsSetAttachVpnGatewayResult"> <summary> Checks if AttachVpnGatewayResult property is set </summary> <returns>true if AttachVpnGatewayResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayResponse.AttachVpnGatewayResult"> <summary> Gets and sets the AttachVpnGatewayResult property. Attach VpnGateway Result </summary> </member> <member name="T:Amazon.EC2.Model.AttachVpnGatewayResult"> <summary> Attach VpnGateway Result </summary> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayResult.IsSetVpcAttachment"> <summary> Checks if VpcAttachment property is set </summary> <returns>true if VpcAttachment property is set</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayResult.VpcAttachment"> <summary> Gets and sets the VpcAttachment property. VPC Attachment </summary> </member> <member name="T:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest"> <summary> Adds one or more egress rules to a VPC security group. </summary> <remarks> <para> This call permits instances in a security group to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups in the same VPC. </para> <para> This action applies only to security groups in a VPC; it's not supported for standard (EC2) security groups. </para> <para> Each rule consists of the protocol (e.g., 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 as a wildcard for the ICMP type or code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </remarks> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.WithGroupId(System.String)"> <summary> Sets the ID of the VPC security group to modify. </summary> <param name="groupId">ID of the VPC security group to modify.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.WithIpPermissions(Amazon.EC2.Model.IpPermissionSpecification[])"> <summary> Sets the IP permissions associated with the security group. </summary> <param name="list">Set of IP permissions associated with the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.IsSetIpPermissions"> <summary> Checks if IpPermissions property is set </summary> <returns>true if IpPermissions property is set</returns> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.GroupId"> <summary> ID of the VPC security group to modify. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.IpPermissions"> <summary> Set of IP permissions associated with the security group. </summary> </member> <member name="T:Amazon.EC2.Model.AuthorizeSecurityGroupEgressResponse"> <summary> The Response for the AuthorizeSecurityGroupEgress operation. </summary> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupEgressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupEgressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupEgressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupEgressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest"> <summary> Adds one or more ingress rules to a security group. This action applies to both EC2 security groups and VPC security groups. </summary> <remarks> Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields. Permission changes are propagated to instances within the security group as quickly as possible. However, depending on the number of instances, a small delay might occur. When authorizing a user/group pair permission, GroupName, SourceSecurityGroupName and SourceSecurityGroupOwnerId must be specified. When authorizing a CIDR IP permission, GroupName, IpProtocol, FromPort, ToPort and CidrIp must be specified </remarks> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithUserId(System.String)"> <summary> Sets the AWS Access Key ID. </summary> <param name="userId">AWS Access Key ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetUserId"> <summary> Checks if UserId property is set </summary> <returns>true if UserId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithGroupId(System.String)"> <summary> Sets the Id of the standard (EC2) or VPC security group to modify. </summary> <param name="groupId">Id of the standard (EC2) or VPC security group to modify. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithGroupName(System.String)"> <summary> Sets the name of the EC2 security group to modify. </summary> <param name="groupName">Name of the group to modify.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithSourceSecurityGroupName(System.String)"> <summary> Sets the name of the source security group. </summary> <param name="sourceSecurityGroupName">Name of the security group. Cannot be used when specifying a CIDR IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetSourceSecurityGroupName"> <summary> Checks if SourceSecurityGroupName property is set </summary> <returns>true if SourceSecurityGroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithSourceSecurityGroupOwnerId(System.String)"> <summary> Sets the ID of the source security group. </summary> <param name="sourceSecurityGroupOwnerId">AWS User ID of an account. Cannot be used when specifying a CIDR IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetSourceSecurityGroupOwnerId"> <summary> Checks if SourceSecurityGroupOwnerId property is set </summary> <returns>true if SourceSecurityGroupOwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithIpProtocol(System.String)"> <summary> Sets the IP protocol name or number. </summary> <param name="ipProtocol">IP protocol.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetIpProtocol"> <summary> Checks if IpProtocol property is set </summary> <returns>true if IpProtocol property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithFromPort(System.Decimal)"> <summary> Sets the start of port range for the TCP and UDP protocols, or an ICMP type number. </summary> <param name="fromPort">The start of port range for the TCP and UDP protocols, or an ICMP type number. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetFromPort"> <summary> Checks if FromPort property is set </summary> <returns>true if FromPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithToPort(System.Decimal)"> <summary> Sets the end of port range for the TCP and UDP protocols, or an ICMP code number. </summary> <param name="toPort">End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetToPort"> <summary> Checks if ToPort property is set </summary> <returns>true if ToPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithCidrIp(System.String)"> <summary> Sets the CIDR range. </summary> <param name="cidrIp">CIDR range.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetCidrIp"> <summary> Checks if CidrIp property is set </summary> <returns>true if CidrIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.WithIpPermissions(Amazon.EC2.Model.IpPermissionSpecification[])"> <summary> Sets the IP permissions associated with the security group. </summary> <param name="list">Set of IP permissions associated with the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IsSetIpPermissions"> <summary> Checks if IpPermissions property is set </summary> <returns>true if IpPermissions property is set</returns> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.UserId"> <summary> AWS Access Key ID. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.GroupId"> <summary> Id of the standard (EC2) or VPC security group to modify. The group must belong to your account. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.GroupName"> <summary> The name of the EC2 security group to modify. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.SourceSecurityGroupName"> <summary> The name of the source security group. Cannot be used when specifying a CIDR IP address. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.SourceSecurityGroupOwnerId"> <summary> The ID of the source security group. Cannot be used when specifying a CIDR IP address. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IpProtocol"> <summary> The IP protocol name or number. EC2 security groups can have rules only for TCP, UDP, and ICMP, whereas VPC security groups can have rules assigned to any protocol number. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.FromPort"> <summary> The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, you can use -1 to specify all ICMP types. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.ToPort"> <summary> The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, you can use -1 to specify all ICMP codes for the given ICMP type. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.CidrIp"> <summary> The CIDR range. Cannot be used when specifying a source security group. </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IpPermissions"> <summary> Set of IP permissions associated with the security group. </summary> </member> <member name="T:Amazon.EC2.Model.AuthorizeSecurityGroupIngressResponse"> <summary> Authorize Security GroupIngress Response </summary> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.AvailabilityZone"> <summary> Availability Zone </summary> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.WithZoneName(System.String)"> <summary> Sets the name of the Availability Zone. </summary> <param name="zoneName">Name of the Availability Zone.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.IsSetZoneName"> <summary> Checks if ZoneName property is set </summary> <returns>true if ZoneName property is set</returns> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.WithZoneState(System.String)"> <summary> Sets the state of the Availability Zone. </summary> <param name="zoneState">State of the Availability Zone.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.IsSetZoneState"> <summary> Checks if ZoneState property is set </summary> <returns>true if ZoneState property is set</returns> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.WithRegionName(System.String)"> <summary> Sets the Region the Availablity Zone is in </summary> <param name="regionName">Name of the region.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.IsSetRegionName"> <summary> Checks if RegionName property is set </summary> <returns>true if RegionName property is set</returns> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.WithMessage(System.String[])"> <summary> Sets information about the Availability Zone. </summary> <param name="list">The Availability Zone messages.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.AvailabilityZone.IsSetMessage"> <summary> Checks if Message property is set </summary> <returns>true if Message property is set</returns> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.ZoneName"> <summary> Name of the Availability Zone. </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.ZoneState"> <summary> State of the Availability Zone. </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.RegionName"> <summary> The Region the Availablity Zone is in </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.Message"> <summary> Information about the Availability Zone. </summary> </member> <member name="T:Amazon.EC2.Model.BlockDeviceMapping"> <summary> Block device mapping. </summary> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.WithDeviceName(System.String)"> <summary> Sets the device name exposed to the instance (e.g., /dev/sdh). </summary> <param name="deviceName">The device name (e.g., /dev/sdh).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.IsSetDeviceName"> <summary> Checks if DeviceName property is set </summary> <returns>true if DeviceName property is set</returns> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.WithVirtualName(System.String)"> <summary> Sets the virtual device name. </summary> <param name="virtualName">The virtual name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.IsSetVirtualName"> <summary> Checks if VirtualName property is set </summary> <returns>true if VirtualName property is set</returns> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.WithEbs(Amazon.EC2.Model.EbsBlockDevice)"> <summary> Sets parameters that are used to automatically set up Amazon EBS volumes when the instance is launched. </summary> <param name="ebs">Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.IsSetEbs"> <summary> Checks if Ebs property is set </summary> <returns>true if Ebs property is set</returns> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.WithNoDevice(System.String)"> <summary> Sets the name of a device to suppress in the block device mapping of the AMI. </summary> <param name="noDevice">Specifies the device name to suppress during instance launch.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BlockDeviceMapping.IsSetNoDevice"> <summary> Checks if NoDevice property is set </summary> <returns>true if NoDevice property is set</returns> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.DeviceName"> <summary> The device name exposed to the instance (e.g., /dev/sdh). </summary> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.VirtualName"> <summary> The virtual device name. </summary> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.Ebs"> <summary> Parameters that are used to automatically set up Amazon EBS volumes when the instance is launched. </summary> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.NoDevice"> <summary> The name of a device to suppress in the block device mapping of the AMI. </summary> </member> <member name="T:Amazon.EC2.Model.BundleInstanceRequest"> <summary> Bundles an Amazon instance store-backed Windows instance. This procedure is not applicable for Linux and UNIX instances. During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </summary> </member> <member name="M:Amazon.EC2.Model.BundleInstanceRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance to bundle. </summary> <param name="instanceId">The ID of the instance to bundle.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceRequest.WithStorage(Amazon.EC2.Model.Storage)"> <summary> Sets the storage configuration for the bundle </summary> <param name="storage">Storage</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceRequest.IsSetStorage"> <summary> Checks if Storage property is set </summary> <returns>true if Storage property is set</returns> </member> <member name="P:Amazon.EC2.Model.BundleInstanceRequest.InstanceId"> <summary> The ID of the instance to bundle. </summary> </member> <member name="P:Amazon.EC2.Model.BundleInstanceRequest.Storage"> <summary> Storage configuration for the bundle </summary> </member> <member name="T:Amazon.EC2.Model.BundleInstanceResponse"> <summary> Bundle Instance Response </summary> </member> <member name="M:Amazon.EC2.Model.BundleInstanceResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceResponse.IsSetBundleInstanceResult"> <summary> Checks if BundleInstanceResult property is set </summary> <returns>true if BundleInstanceResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.BundleInstanceResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.BundleInstanceResponse.BundleInstanceResult"> <summary> Gets and sets the BundleInstanceResult property. Bundle Instance Result </summary> </member> <member name="T:Amazon.EC2.Model.BundleInstanceResult"> <summary> Bundle Instance Result </summary> </member> <member name="M:Amazon.EC2.Model.BundleInstanceResult.IsSetBundleTask"> <summary> Checks if BundleTask property is set </summary> <returns>true if BundleTask property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.BundleInstanceResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.BundleInstanceResult.BundleTask"> <summary> Gets and sets the BundleTask property. </summary> </member> <member name="T:Amazon.EC2.Model.BundleTask"> <summary> Bundle Task </summary> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithInstanceId(System.String)"> <summary> Sets the ID of the instance associated with this bundle task. </summary> <param name="instanceId">Instance associated with this bundle task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithBundleId(System.String)"> <summary> Sets the ID for this bundle task. </summary> <param name="bundleId">Identifier for this task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetBundleId"> <summary> Checks if BundleId property is set </summary> <returns>true if BundleId property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithBundleState(System.String)"> <summary> Sets the state of the task. </summary> <param name="bundleState">The state of the task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetBundleState"> <summary> Checks if BundleState property is set </summary> <returns>true if BundleState property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithStartTime(System.String)"> <summary> Sets the time this task started. </summary> <param name="startTime">The time this task started.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetStartTime"> <summary> Checks if StartTime property is set </summary> <returns>true if StartTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithUpdateTime(System.String)"> <summary> Sets the time of the most recent update for the task. </summary> <param name="updateTime">The time of the most recent update for the task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetUpdateTime"> <summary> Checks if UpdateTime property is set </summary> <returns>true if UpdateTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithStorage(Amazon.EC2.Model.Storage)"> <summary> Sets the Amazon S3 storage locations. </summary> <param name="storage">Amazon S3 storage locations.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetStorage"> <summary> Checks if Storage property is set </summary> <returns>true if Storage property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithProgress(System.String)"> <summary> Sets the level of task completion, as a percent (for example, 20%). </summary> <param name="progress">The level of task completion, in percent (e.g., 20%).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetProgress"> <summary> Checks if Progress property is set </summary> <returns>true if Progress property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.WithBundleTaskError(Amazon.EC2.Model.BundleTaskError)"> <summary> Sets the description of an error if the task fails </summary> <param name="bundleTaskError">If the task fails, a description of the error.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTask.IsSetBundleTaskError"> <summary> Checks if BundleTaskError property is set </summary> <returns>true if BundleTaskError property is set</returns> </member> <member name="P:Amazon.EC2.Model.BundleTask.InstanceId"> <summary> The ID of the instance associated with this bundle task. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.BundleId"> <summary> The ID for this bundle task. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.BundleState"> <summary> The state of the task. Valid Values: pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.StartTime"> <summary> The time this task started. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.UpdateTime"> <summary> The time of the most recent update for the task. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.Storage"> <summary> The Amazon S3 storage locations. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.Progress"> <summary> The level of task completion, as a percent (for example, 20%). </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.BundleTaskError"> <summary> If the task fails, a description of the error. </summary> </member> <member name="T:Amazon.EC2.Model.BundleTaskError"> <summary> If the task fails, a description of the error. </summary> </member> <member name="M:Amazon.EC2.Model.BundleTaskError.WithCode(System.String)"> <summary> Sets the error code. </summary> <param name="code">Error code.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTaskError.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.BundleTaskError.WithMessage(System.String)"> <summary> Sets the error message. </summary> <param name="message">Error message.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.BundleTaskError.IsSetMessage"> <summary> Checks if Message property is set </summary> <returns>true if Message property is set</returns> </member> <member name="P:Amazon.EC2.Model.BundleTaskError.Code"> <summary> Error code. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTaskError.Message"> <summary> Error message. </summary> </member> <member name="T:Amazon.EC2.Model.CancelBundleTaskRequest"> <summary> Cancels a bundling operation for an instance store-backed Windows instance. </summary> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskRequest.WithBundleId(System.String)"> <summary> Sets the ID of the bundle task to cancel. </summary> <param name="bundleId">The ID of the bundle task to cancel.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskRequest.IsSetBundleId"> <summary> Checks if BundleId property is set </summary> <returns>true if BundleId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CancelBundleTaskRequest.BundleId"> <summary> The ID of the bundle task to cancel. </summary> </member> <member name="T:Amazon.EC2.Model.CancelBundleTaskResponse"> <summary> CancelBundleTaskResponse </summary> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskResponse.IsSetCancelBundleTaskResult"> <summary> Checks if CancelBundleTaskResult property is set </summary> <returns>true if CancelBundleTaskResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelBundleTaskResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CancelBundleTaskResponse.CancelBundleTaskResult"> <summary> Gets and sets the CancelBundleTaskResult property. Cancel Bundle Task Result </summary> </member> <member name="T:Amazon.EC2.Model.CancelBundleTaskResult"> <summary> Cancel Bundle Task Result </summary> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskResult.IsSetBundleTask"> <summary> Checks if BundleTask property is set </summary> <returns>true if BundleTask property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelBundleTaskResult.BundleTask"> <summary> Gets and sets the BundleTask property. List of bundle tasks </summary> </member> <member name="T:Amazon.EC2.Model.CancelConversionTaskRequest"> <summary> Cancels an active conversion task. The task can be the import of an instance or volume. </summary> <remarks> The command 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. </remarks> </member> <member name="M:Amazon.EC2.Model.CancelConversionTaskRequest.WithConversionTaskId(System.String)"> <summary> Sets the ID of the task you want to cancel. </summary> <param name="conversionTaskId">The ID of the task you want to cancel.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CancelConversionTaskRequest.IsSetConversionTaskId"> <summary> Checks if ConversionTaskId property is set </summary> <returns>true if ConversionTaskId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CancelConversionTaskRequest.ConversionTaskId"> <summary> The ID of the task you want to cancel. </summary> </member> <member name="T:Amazon.EC2.Model.CancelConversionTaskResponse"> <summary> The Response for the CancelConversionTask operation. </summary> </member> <member name="M:Amazon.EC2.Model.CancelConversionTaskResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelConversionTaskResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelConversionTaskResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelConversionTaskResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CancelExportTaskRequest"> <summary> Cancels an active export task. </summary> <remarks> The action 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 action fails and returns an error. </remarks> </member> <member name="M:Amazon.EC2.Model.CancelExportTaskRequest.WithExportTaskId(System.String)"> <summary> Sets the ID of the export task you want to cancel. </summary> <param name="exportTaskId">Id of the export task to cancel</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CancelExportTaskRequest.IsSetExportTaskId"> <summary> Checks if the ExportTaskId property is set. </summary> <returns>True if the ExportTaskId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CancelExportTaskRequest.ExportTaskId"> <summary> The ID of the export task you want to cancel. </summary> </member> <member name="T:Amazon.EC2.Model.CancelExportTaskResponse"> <summary> The Response for the CancelExportTask operation. </summary> </member> <member name="M:Amazon.EC2.Model.CancelExportTaskResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelExportTaskResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelExportTaskResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelExportTaskResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CancelledSpotInstanceRequest"> <summary> A cancelled Spot Instance Request. </summary> </member> <member name="M:Amazon.EC2.Model.CancelledSpotInstanceRequest.WithSpotInstanceRequestId(System.String)"> <summary> Sets the ID of the Spot Instance Request. </summary> <param name="spotInstanceRequestId">The ID of the Spot Instance Request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CancelledSpotInstanceRequest.IsSetSpotInstanceRequestId"> <summary> Checks if SpotInstanceRequestId property is set </summary> <returns>true if SpotInstanceRequestId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelledSpotInstanceRequest.WithState(System.String)"> <summary> Sets the State of the Spot Instance Request. </summary> <param name="state">The State of the Spot Instance Request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CancelledSpotInstanceRequest.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="P:Amazon.EC2.Model.CancelledSpotInstanceRequest.SpotInstanceRequestId"> <summary> The ID of the Spot Instance Request. </summary> </member> <member name="P:Amazon.EC2.Model.CancelledSpotInstanceRequest.State"> <summary> The State of the Spot Instance Request. Valid values are open | closed | cancelled | failed </summary> </member> <member name="T:Amazon.EC2.Model.CancelReservedInstancesListingRequest"> <summary> Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. </summary> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingRequest.WithReservedInstancesListingId(System.String)"> <summary> Sets the ID of the Reserved Instance listing to be canceled. </summary> <param name="reservedInstancesListingId">Listing Id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingRequest.IsSetReservedInstancesListingId"> <summary> Checks if the ReservedInstancesListingId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.CancelReservedInstancesListingRequest.ReservedInstancesListingId"> <summary> The ID of the Reserved Instance listing to be canceled. </summary> </member> <member name="T:Amazon.EC2.Model.CancelReservedInstancesListingResponse"> <summary> Cancel Reserved Instances Listing response from the service </summary> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingResponse.IsSetCancelReservedInstancesListingResult"> <summary> Checks if CancelReservedInstancesListingResult property is set </summary> <returns>true if CancelReservedInstancesListingResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelReservedInstancesListingResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CancelReservedInstancesListingResponse.CancelReservedInstancesListingResult"> <summary> Gets and sets the CancelReservedInstancesListingResult property. </summary> </member> <member name="T:Amazon.EC2.Model.CancelReservedInstancesListingResult"> <summary> Cancel Reserved Instances Listing Result </summary> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingResult.IsSetReservedInstancesListings"> <summary> Checks if the ReservedInstancesListings property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelReservedInstancesListingResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelReservedInstancesListingResult.ReservedInstancesListings"> <summary> Collection of Reserved Instance Listings that have been cancelled. </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest"> <summary> Cancels one or more Spot Instance requests. </summary> <remarks> Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum 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. </remarks> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest.WithSpotInstanceRequestId(System.String[])"> <summary> Sets the Spot Instance requests that you want to cancel. </summary> <param name="list">The list of Spot Instance requests that you want to cancel.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest.IsSetSpotInstanceRequestId"> <summary> Checks if SpotInstanceRequestId property is set </summary> <returns>true if SpotInstanceRequestId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest.SpotInstanceRequestId"> <summary> The list of Spot Instance requests that you want to cancel. </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse"> <summary> The Response from the CancelSpotInstanceRequests operation. </summary> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse.IsSetCancelSpotInstanceRequestsResult"> <summary> Checks if CancelSpotInstanceRequestsResult property is set </summary> <returns>true if CancelSpotInstanceRequestsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse.CancelSpotInstanceRequestsResult"> <summary> Gets and sets the CancelSpotInstanceRequestsResult property. The Cancel Spot Instance Requests Result. </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotInstanceRequestsResult"> <summary> The Cancel Spot Instance Requests Result. </summary> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsResult.IsSetCancelledSpotInstanceRequest"> <summary> Checks if CancelledSpotInstanceRequest property is set </summary> <returns>true if CancelledSpotInstanceRequest property is set</returns> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CancelSpotInstanceRequestsResult.CancelledSpotInstanceRequest"> <summary> Gets and sets the CancelledSpotInstanceRequest property. The list of cancelled Spot Instance requests. </summary> </member> <member name="T:Amazon.EC2.Model.ConfirmProductInstanceRequest"> <summary> Determines whether a product code is associated with an instance. </summary> <remarks> 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 EC2 user�s instance is eligible for support. </remarks> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceRequest.WithProductCode(System.String)"> <summary> Sets the product code to confirm. </summary> <param name="productCode">The product code to confirm.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceRequest.IsSetProductCode"> <summary> Checks if ProductCode property is set </summary> <returns>true if ProductCode property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceRequest.WithInstanceId(System.String)"> <summary> Sets the instance to confirm. </summary> <param name="instanceId">The instance to confirm.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceRequest.ProductCode"> <summary> The product code to confirm. </summary> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceRequest.InstanceId"> <summary> The instance to confirm. </summary> </member> <member name="T:Amazon.EC2.Model.ConfirmProductInstanceResponse"> <summary> Confirm Product Instance Response </summary> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceResponse.IsSetConfirmProductInstanceResult"> <summary> Checks if ConfirmProductInstanceResult property is set </summary> <returns>true if ConfirmProductInstanceResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceResponse.ConfirmProductInstanceResult"> <summary> Gets and sets the ConfirmProductInstanceResult property. Confirm Product Instance Result </summary> </member> <member name="T:Amazon.EC2.Model.ConfirmProductInstanceResult"> <summary> Confirm Product Instance Result </summary> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceResult.IsSetOwnerId"> <summary> Checks if OwnerId property is set </summary> <returns>true if OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceResult.OwnerId"> <summary> Gets and sets the OwnerId property. The instance owner's account ID. Only present if the product code is attached to the instance. </summary> </member> <member name="T:Amazon.EC2.Model.ConsoleOutput"> <summary> Instance console output </summary> </member> <member name="M:Amazon.EC2.Model.ConsoleOutput.WithInstanceId(System.String)"> <summary> Sets the instance ID. </summary> <param name="instanceId">The instance ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConsoleOutput.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConsoleOutput.WithTimestamp(System.String)"> <summary> Sets the time the output was last updated. </summary> <param name="timestamp">The time the output was last updated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConsoleOutput.IsSetTimestamp"> <summary> Checks if Timestamp property is set </summary> <returns>true if Timestamp property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConsoleOutput.WithOutput(System.String)"> <summary> Sets the console output, Base64 encoded. </summary> <param name="output">The console output, Base64 encoded.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConsoleOutput.IsSetOutput"> <summary> Checks if Output property is set </summary> <returns>true if Output property is set</returns> </member> <member name="P:Amazon.EC2.Model.ConsoleOutput.InstanceId"> <summary> The instance ID. </summary> </member> <member name="P:Amazon.EC2.Model.ConsoleOutput.Timestamp"> <summary> The time the output was last updated. </summary> </member> <member name="P:Amazon.EC2.Model.ConsoleOutput.Output"> <summary> The console output, Base64 encoded. </summary> </member> <member name="T:Amazon.EC2.Model.ConversionTaskType"> <summary> Conversion task </summary> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.WithConversionTaskId(System.String)"> <summary> Sets the ID of the conversion task. </summary> <param name="conversionTaskId">ID of the conversion task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.IsSetConversionTaskId"> <summary> Checks if ConversionTaskId property is set </summary> <returns>true if ConversionTaskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.WithExpirationTime(System.String)"> <summary> Sets the time when the task expires. </summary> <param name="expirationTime">When the task expires. If the upload isn't complete before the expiration time, the task is automatically canceled.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.IsSetExpirationTime"> <summary> Checks if ExpirationTime property is set </summary> <returns>true if ExpirationTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.WithImportVolumeRequest(Amazon.EC2.Model.ImportVolumeTaskDetailsType)"> <summary> Sets the import volume task information. </summary> <param name="importVolumeRequest">If the task is for importing a volume, this contains information about the import volume task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.IsSetImportVolumeRequest"> <summary> Checks if ImportVolumeRequest property is set </summary> <returns>true if ImportVolumeRequest property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.WithImportInstanceRequest(Amazon.EC2.Model.ImportInstanceTaskDetailsType)"> <summary> Sets the import instance task information. </summary> <param name="importInstanceRequest">If the task is for importing an instance, this contains information about the import instance task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.IsSetImportInstanceRequest"> <summary> Checks if ImportInstanceRequest property is set </summary> <returns>true if ImportInstanceRequest property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.WithState(System.String)"> <summary> Sets the state of the conversion task. Valid values: active | cancelling | cancelled | completed </summary> <param name="state">State of the conversion task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.WithStatusMessage(System.String)"> <summary> Sets the status message related to the conversion task. </summary> <param name="statusMessage">Status message related to the conversion task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ConversionTaskType.IsSetStatusMessage"> <summary> Checks if StatusMessage property is set </summary> <returns>true if StatusMessage property is set</returns> </member> <member name="P:Amazon.EC2.Model.ConversionTaskType.ConversionTaskId"> <summary> ID of the conversion task. </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTaskType.ExpirationTime"> <summary> The time when the task expires. If the upload isn't complete before the expiration time, the task is automatically canceled. </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTaskType.ImportVolumeRequest"> <summary> If the task is for importing a volume, this contains information about the import volume task. </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTaskType.ImportInstanceRequest"> <summary> If the task is for importing an instance, this contains information about the import instance task. </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTaskType.State"> <summary> The state of the conversion task. </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTaskType.StatusMessage"> <summary> Status message related to the conversion task. </summary> </member> <member name="T:Amazon.EC2.Model.CopyImageRequest"> <summary> Container for the parameters to the CopyImage operation. <para>Initiates the copy of an AMI from the specified source region to the region in which the request was made. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.</para> <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> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.WithSourceRegion(System.String)"> <summary> Sets the source region to copy the image from. </summary> <param name="sourceRegion">Source region.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.IsSetSourceRegion"> <summary> Checks if SourceRegion property is set </summary> <returns>true if SourceRegion property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.WithSourceImageId(System.String)"> <summary> Sets the id of the source image to copy. </summary> <param name="sourceImageId">Image id.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.IsSetSourceImageId"> <summary> Checks if SourceImageId property is set </summary> <returns>true if SourceImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.WithDescription(System.String)"> <summary> Sets the description of the image copy. </summary> <param name="description">Description.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.WithName(System.String)"> <summary> Sets the name of the image copy. </summary> <param name="name">Name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.IsSetName"> <summary> Checks if Name property is set </summary> <returns>true if Name property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.WithClientToken(System.String)"> <summary> Sets the ClientToken property. </summary> <param name="clientToken">ClientToken.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageRequest.IsSetClientToken"> <summary> Checks if ClientToken property is set </summary> <returns>true if ClientToken property is set</returns> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.SourceRegion"> <summary> Source region to copy the image from. </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.SourceImageId"> <summary> Id of the source image to copy. </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.Description"> <summary> Description of the image copy. </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.Name"> <summary> Name of the image copy. </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.ClientToken"> <summary> A unique, case-sensitive identifier you provide to ensure idempotency of the copy. </summary> </member> <member name="T:Amazon.EC2.Model.CopyImageResponse"> <summary> Copy Image Response </summary> </member> <member name="M:Amazon.EC2.Model.CopyImageResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageResponse.IsSetCreateKeyPairResult"> <summary> Checks if CopyImageResult property is set </summary> <returns>true if CopyImageResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CopyImageResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageResponse.CopyImageResult"> <summary> Gets and sets the CopyImageResult property. Copy Image Result </summary> </member> <member name="M:Amazon.EC2.Model.CopyImageResult.IsSetImage"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CopyImageResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CopyImageResult.ImageId"> <summary> Gets and sets the ImageId property. Id of the snapshot </summary> </member> <member name="T:Amazon.EC2.Model.CopySnapshotRequest"> <summary> Container for the parameters to the CopySnapshot operation. <para>Copies a point-in-time snapshot of an Amazon 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 Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.</para> <para>Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.</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> </member> <member name="M:Amazon.EC2.Model.CopySnapshotRequest.WithSourceRegion(System.String)"> <summary> Sets the source region to copy the snapshot from. </summary> <param name="sourceRegion">Source region.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotRequest.IsSetSourceRegion"> <summary> Checks if SourceRegion property is set </summary> <returns>true if SourceRegion property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotRequest.WithSourceSnapshotId(System.String)"> <summary> Sets the id of the source snapshot to copy. </summary> <param name="sourceSnapshotId">Snapshot id.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotRequest.IsSetSourceSnapshotId"> <summary> Checks if SourceSnapshotId property is set </summary> <returns>true if SourceSnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotRequest.WithDescription(System.String)"> <summary> Sets the description of the snapshot copy. </summary> <param name="description">Description.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.SourceRegion"> <summary> Source region to copy the snapshot from. </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.SourceSnapshotId"> <summary> Id of the source snapshot to copy. </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.Description"> <summary> Description of the snapshot copy. </summary> </member> <member name="T:Amazon.EC2.Model.CopySnapshotResponse"> <summary> Copy Snapshot Response </summary> </member> <member name="M:Amazon.EC2.Model.CopySnapshotResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotResponse.IsSetCreateKeyPairResult"> <summary> Checks if CopySnapshotResult property is set </summary> <returns>true if CopySnapshotResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CopySnapshotResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotResponse.CopySnapshotResult"> <summary> Gets and sets the CopySnapshotResult property. Copy Snapshot Result </summary> </member> <member name="T:Amazon.EC2.Model.CopySnapshotResult"> <summary> Copy Snapshot Result </summary> </member> <member name="M:Amazon.EC2.Model.CopySnapshotResult.IsSetKeyPair"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CopySnapshotResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CopySnapshotResult.SnapshotId"> <summary> Gets and sets the SnapshotId property. Id of the snapshot </summary> </member> <member name="T:Amazon.EC2.Model.CreateCustomerGatewayRequest"> <summary> Provides information to AWS about your customer gateway device. </summary> <remarks> The customer gateway is the appliance at your end of the VPN connection (compared to the VPN gateway, which is the device at the AWS side of the VPN connection). AWS might delete any customer gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer 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). For device�s that use Border Gateway Protocal (BGP), you can also provide the device's Border Gateway Protocol (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). Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in US East, and 9059, which is reserved in EU West For more information about ASNs, go to the Wikipedia article - http://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.WithType(System.String)"> <summary> Sets the type of VPN connection this customer gateway supports. </summary> <param name="type">The type of VPN connection this customer gateway supports.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.WithIpAddress(System.String)"> <summary> Sets the Internet-routable IP address for the customer gateway's outside interface. </summary> <param name="ipAddress">The Internet-routable IP address for the customer gateway's outside interface. The address must be static.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.IsSetIpAddress"> <summary> Checks if IpAddress property is set </summary> <returns>true if IpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.WithBgpAsn(System.Decimal)"> <summary> Sets the customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN) for devices that support BGP. </summary> <param name="bgpAsn">The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.IsSetBgpAsn"> <summary> Checks if BgpAsn property is set </summary> <returns>true if BgpAsn property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayRequest.Type"> <summary> The type of VPN connection this customer gateway supports. </summary> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayRequest.IpAddress"> <summary> The Internet-routable IP address for the customer gateway's outside interface. The address must be static. </summary> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayRequest.BgpAsn"> <summary> The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN) for devices that support BGP. </summary> </member> <member name="T:Amazon.EC2.Model.CreateCustomerGatewayResponse"> <summary> Create Customer Gateway Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayResponse.IsSetCreateCustomerGatewayResult"> <summary> Checks if CreateCustomerGatewayResult property is set </summary> <returns>true if CreateCustomerGatewayResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayResponse.CreateCustomerGatewayResult"> <summary> Gets and sets the CreateCustomerGatewayResult property. Create Customer Gateway Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateCustomerGatewayResult"> <summary> Create Customer Gateway Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayResult.IsSetCustomerGateway"> <summary> Checks if CustomerGateway property is set </summary> <returns>true if CustomerGateway property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayResult.CustomerGateway"> <summary> Gets and sets the CustomerGateway property. Customer gateway </summary> </member> <member name="T:Amazon.EC2.Model.CreateDhcpOptionsRequest"> <summary> Container for the parameters to the CreateDhcpOptions operation. <para>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> .</para> <ul> <li> <c>domain-name-servers</c> - The IP addresses of up to four domain name servers, or <c>AmazonProvidedDNS</c> . The default DHCP option set specifies <c>AmazonProvidedDNS</c> . If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <c>domain-name</c> - If you're using AmazonProvidedDNS in <c>us-east-1</c> , specify <c>ec2.internal</c> . If you're using AmazonProvidedDNS in another region, specify <c>region.compute.internal</c> (for example, <c>ap-northeast-1.compute.internal</c> ). Otherwise, specify a domain name (for example, <c>MyCompany.com</c> ).</li> <li> <c>ntp-servers</c> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <c>netbios-name-servers</c> - The IP addresses of up to four NetBIOS name servers.</li> <li> <c>netbios-node-type</c> - 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>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> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsRequest.WithDhcpConfiguration(Amazon.EC2.Model.DhcpConfiguration[])"> <summary> Sets the DHCP Configuration </summary> <param name="list">DHCP Configuration</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsRequest.IsSetDhcpConfiguration"> <summary> Checks if DhcpConfiguration property is set </summary> <returns>true if DhcpConfiguration property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateDhcpOptionsRequest.DhcpConfiguration"> <summary> DHCP Configuration </summary> </member> <member name="T:Amazon.EC2.Model.CreateDhcpOptionsResponse"> <summary> Create Dhcp Options Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsResponse.IsSetCreateDhcpOptionsResult"> <summary> Checks if CreateDhcpOptionsResult property is set </summary> <returns>true if CreateDhcpOptionsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateDhcpOptionsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateDhcpOptionsResponse.CreateDhcpOptionsResult"> <summary> Gets and sets the CreateDhcpOptionsResult property. Create Dhcp Options Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateDhcpOptionsResult"> <summary> Create Dhcp Options Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsResult.IsSetDhcpOptions"> <summary> Checks if DhcpOptions property is set </summary> <returns>true if DhcpOptions property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateDhcpOptionsResult.DhcpOptions"> <summary> Gets and sets the DhcpOptions property. Dhcp options </summary> </member> <member name="T:Amazon.EC2.Model.CreateImageRequest"> <summary> Creates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started. </summary> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance. </summary> <param name="instanceId">The ID of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.WithName(System.String)"> <summary> Sets the name for the new image. </summary> <param name="name">The name of the AMI that was provided during image creation.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.IsSetName"> <summary> Checks if Name property is set </summary> <returns>true if Name property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.WithDescription(System.String)"> <summary> Sets the description of the new image. </summary> <param name="description"> The description of the new image. Can be up to 255 characters. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.WithNoReboot(System.Boolean)"> <summary> Sets whether Amazon EC2 should not shut down an instance before image creation. </summary> <param name="noReboot">By default this property is set to false, which means Amazon EC2 attempts to cleanly shut down the instance before image creation and reboots the instance afterwards. When set to true, Amazon EC2 does not shut down the instance before creating the image. When this option is used, file system integrity on the created image cannot be guaranteed. Default is FALSE.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.IsSetNoReboot"> <summary> Checks if NoReboot property is set </summary> <returns>true if NoReboot property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.WithBlockDeviceMapping(Amazon.EC2.Model.BlockDeviceMapping[])"> <summary> Sets the block device mapping information for the image. </summary> <param name="list">BlockDeviceMapping property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.InstanceId"> <summary> The ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.Name"> <summary> The name for the new image. </summary> <remarks> Must be 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores(_). </remarks> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.Description"> <summary> A description of the new image. </summary> <remarks>Can be up to 255 characters.</remarks> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.NoReboot"> <summary> Whether Amazon EC2 should not shut down an instance before image creation. </summary> <remarks> By default this property is set to false, which means Amazon EC2 attempts to cleanly shut down the instance before image creation and reboots the instance afterwards. When set to true, Amazon EC2 does not shut down the instance before creating the image. When this option is used, file system integrity on the created image cannot be guaranteed. Default is FALSE. </remarks> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.BlockDeviceMapping"> <summary> Block device mapping information for the image. </summary> </member> <member name="T:Amazon.EC2.Model.CreateImageResponse"> <summary> Information returned by a CreateImage request. </summary> </member> <member name="M:Amazon.EC2.Model.CreateImageResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageResponse.IsSetCreateImageResult"> <summary> Checks if CreateImageResult property is set </summary> <returns>true if CreateImageResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateImageResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageResponse.CreateImageResult"> <summary> Gets and sets the CreateImageResult property. Information about the created image. </summary> </member> <member name="T:Amazon.EC2.Model.CreateImageResult"> <summary> Information about the created image. </summary> </member> <member name="M:Amazon.EC2.Model.CreateImageResult.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateImageResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateImageResult.ImageId"> <summary> Gets and sets the ImageId property. The ID of the AMI. </summary> </member> <member name="T:Amazon.EC2.Model.CreateInstanceExportTaskRequest"> <summary> Exports a running or stopped instance to an Amazon S3 bucket. </summary> <remarks> Creates a new export task, produces an image of an EC2 instance for use in another virtualization environment, and then writes the image to the specified Amazon S3 bucket. If the instance is running at the time of export, Amazon EC2 will attempt to shut down the instance, initiate the export process, and then reboot the instance. Only instances derived from your own ImportInstance tasks may be exported. When the task is complete, the image can be downloaded from your Amazon S3 bucket. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.WithDescription(System.String)"> <summary> Sets the description of the conversion task or the resource being exported. </summary> <param name="description">Description</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>True if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance being exported. </summary> <param name="instanceId">Id of the instance to export</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.IsSetInstanceId"> <summary> Checks if the InstanceId property is set </summary> <returns>True if the InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.WithTargetEnvironment(System.String)"> <summary> Sets the target virtualization environment </summary> <param name="targetEnvironment">Target environment; valid values: vmware | citrix | microsoft</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.IsSetTargetEnvironment"> <summary> Checks if the TargetEnvironment property is set </summary> <returns>True if the TargetEnvironment property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.WithExportToS3Task(Amazon.EC2.Model.ExportToS3TaskType)"> <summary> Sets the details of the S3 object to be written on export. </summary> <param name="exportToS3TaskType"></param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskRequest.IsSetExportToS3Task"> <summary> Checks if the ExportToS3Task property is set </summary> <returns>True if the ExportToS3Task property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.Description"> <summary> A description of the conversion task or the resource being exported. </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.InstanceId"> <summary> The ID of the instance being exported. </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.TargetEnvironment"> <summary> The target virtualization environment </summary> <remarks>Valid Values: vmware | citrix | microsoft</remarks> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.ExportToS3Task"> <summary> Details of the S3 object to be written on export </summary> </member> <member name="T:Amazon.EC2.Model.CreateInstanceExportTaskResponse"> <summary> </summary> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskResponse.IsSetCreateInstanceExportTaskResult"> <summary> Checks if CreateInstanceExportTaskResult property is set </summary> <returns>true if CreateInstanceExportTaskResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskResponse.CreateInstanceExportTaskResult"> <summary> </summary> </member> <member name="T:Amazon.EC2.Model.CreateInstanceExportTaskResult"> <summary> CreateInstanceExportTaskResult </summary> </member> <member name="M:Amazon.EC2.Model.CreateInstanceExportTaskResult.IsSetExportTask"> <summary> Checks if the ExportTask property is set. </summary> <returns>True if the ExportTask property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskResult.ExportTask"> <summary> Gets and sets the details of the created ExportVM task. </summary> </member> <member name="T:Amazon.EC2.Model.CreateInternetGatewayRequest"> <summary> Creates a new Internet gateway in your AWS account. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway. </summary> </member> <member name="T:Amazon.EC2.Model.CreateInternetGatewayResponse"> <summary> The Response for the CreateInternetGateway operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateInternetGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInternetGatewayResponse.IsSetCreateInternetGatewayResult"> <summary> Checks if CreateInternetGatewayResult property is set </summary> <returns>true if CreateInternetGatewayResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInternetGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateInternetGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateInternetGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateInternetGatewayResponse.CreateInternetGatewayResult"> <summary> Gets and sets the CreateInternetGatewayResult property. CreateInternetGateway Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateInternetGatewayResult"> <summary> CreateInternetGateway Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateInternetGatewayResult.IsSetInternetGateway"> <summary> Checks if InternetGateway property is set </summary> <returns>true if InternetGateway property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateInternetGatewayResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateInternetGatewayResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateInternetGatewayResult.InternetGateway"> <summary> Gets and sets the InternetGateway property. Information about the Internet gateway </summary> </member> <member name="T:Amazon.EC2.Model.CreateKeyPairRequest"> <summary> Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is returned to you. </summary> <remarks> 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. The key pair returned to you works only in the Region you're using when you create the key pair. To create a key pair that works in all Regions, use ImportKeyPair. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairRequest.WithKeyName(System.String)"> <summary> Sets the unique name for the key pair. </summary> <param name="keyName">A unique name for the key pair.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairRequest.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateKeyPairRequest.KeyName"> <summary> A unique name for the key pair. </summary> </member> <member name="T:Amazon.EC2.Model.CreateKeyPairResponse"> <summary> Create Key Pair Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairResponse.IsSetCreateKeyPairResult"> <summary> Checks if CreateKeyPairResult property is set </summary> <returns>true if CreateKeyPairResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateKeyPairResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateKeyPairResponse.CreateKeyPairResult"> <summary> Gets and sets the CreateKeyPairResult property. Create Key Pair Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateKeyPairResult"> <summary> Create Key Pair Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairResult.IsSetKeyPair"> <summary> Checks if KeyPair property is set </summary> <returns>true if KeyPair property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateKeyPairResult.KeyPair"> <summary> Gets and sets the KeyPair property. Key Pair </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclEntryRequest"> <summary> Creates an entry (i.e., rule) in a network ACL with a rule number you specify. </summary> <remarks> 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, Amazon VPC processes the entries in the ACL according to the rule numbers, in ascending order. We recommend that you leave room between the rules (e.g., 100, 110, 120, etc.), and not number them sequentially (101, 102, 103, etc.). This allows you to easily add a new rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create a new entry and delete the old one. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithNetworkAclId(System.String)"> <summary> Sets the ID of the ACL where the entry will be created. </summary> <param name="networkAclId">ID of the ACL where the entry will be created.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithRuleNumber(System.Decimal)"> <summary> Sets the rule number to assign to the entry (e.g., 100). </summary> <param name="ruleNumber">Rule number to assign to the entry (e.g., 100).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetRuleNumber"> <summary> Checks if RuleNumber property is set </summary> <returns>true if RuleNumber property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithProtocol(System.String)"> <summary> Sets the IP protocol the rule applies to. </summary> <param name="protocol">IP protocol the rule applies to.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetProtocol"> <summary> Checks if Protocol property is set </summary> <returns>true if Protocol property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithRuleAction(System.String)"> <summary> Sets whether to allow or deny traffic that matches the rule. </summary> <param name="ruleAction">Whether to allow or deny traffic that matches the rule.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetRuleAction"> <summary> Checks if RuleAction property is set </summary> <returns>true if RuleAction property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithEgress(System.Boolean)"> <summary> Sets whether this rule applies to egress traffic from the subnet (true) or ingress traffic to the subnet (false). </summary> <param name="egress">Whether this rule applies to egress traffic from the subnet (true) or ingress traffic to the subnet (false).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetEgress"> <summary> Checks if Egress property is set </summary> <returns>true if Egress property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithCidrBlock(System.String)"> <summary> Sets the CIDR range to allow or deny, in CIDR notation. </summary> <param name="cidrBlock">The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetCidrBlock"> <summary> Checks if CidrBlock property is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithIcmp(Amazon.EC2.Model.Icmp)"> <summary> Sets the ICMP type and code for the ICMP protocol. </summary> <param name="icmp">For the ICMP protocol, this is the ICMP type and code.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetIcmp"> <summary> Checks if Icmp property is set </summary> <returns>true if Icmp property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.WithPortRange(Amazon.EC2.Model.PortRange)"> <summary> Sets the range of ports the rule applies to, for TCP or UDP protocols. </summary> <param name="portRange">For the TCP or UDP protocols, the range of ports the rule applies to.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IsSetPortRange"> <summary> Checks if PortRange property is set </summary> <returns>true if PortRange property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.NetworkAclId"> <summary> ID of the ACL where the entry will be created. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.RuleNumber"> <summary> Rule number to assign to the entry (e.g., 100). </summary> <remarks> ACL entries are processed in ascending order by rule number. </remarks> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.Protocol"> <summary> The IP protocol the rule applies to. You can use -1 to mean all protocols. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.RuleAction"> <summary> Whether to allow or deny traffic that matches the rule. </summary> <remarks> Valid Values: allow | deny </remarks> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.Egress"> <summary> Whether this rule applies to egress traffic from the subnet (true) or ingress traffic to the subnet (false). </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.CidrBlock"> <summary> The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.Icmp"> <summary> The ICMP type and code for the ICMP protocol. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.PortRange"> <summary> The range of ports the rule applies to, for TCP or UDP protocols. </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclEntryResponse"> <summary> The Response for the CreateNetworkAclEntry operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclEntryResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclRequest"> <summary> Creates a network ACL in a VPC. </summary> <remarks> Network ACLs provide an optional layer of security (on top of security groups) for the instances in your VPC. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC where the network ACL will be created. </summary> <param name="vpcId">The ID of the VPC where the network ACL will be created.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclRequest.VpcId"> <summary> The ID of the VPC where the network ACL will be created. </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclResponse"> <summary> The Response for the CreateNetworkAcl operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclResponse.IsSetCreateNetworkAclResult"> <summary> Checks if CreateNetworkAclResult property is set </summary> <returns>true if CreateNetworkAclResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclResponse.CreateNetworkAclResult"> <summary> Gets and sets the CreateNetworkAclResult property. CreateNetworkAcl Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclResult"> <summary> CreateNetworkAcl Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclResult.IsSetNetworkAcl"> <summary> Checks if NetworkAcl property is set </summary> <returns>true if NetworkAcl property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkAclResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclResult.NetworkAcl"> <summary> Gets and sets the NetworkAcl property. Information about the new network ACL. </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkInterfaceRequest"> <summary> Creates a network interface in the specified subnet. </summary> <remarks> This action is supported only in Amazon VPC. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet to associate with the network interface. </summary> <param name="subnetId">ID of the subnet</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.IsSetSubnetId"> <summary> Checks if the SubnetId property is set </summary> <returns>true if the SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.WithDescription(System.String)"> <summary> Sets the description of the network interface. </summary> <param name="description">Description of the network interface</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>true if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.WithPrivateIpAddress(System.String)"> <summary> Sets the primary private IP address of the network interface. </summary> <param name="ipAddress">IP address of the network interface</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.IsSetPrivateIpAddress"> <summary> Checks if the PrivateIpAddress property is set </summary> <returns>true of the PrivateIpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.WithGroupId(System.String[])"> <summary> Sets the list of security group IDs for use by the network interface. </summary> <param name="list">List of security group IDs</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.IsSetGroupId"> <summary> Checks if the GroupId property is set </summary> <returns>true if the GroupId is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.WithPrivateIpAddresses(Amazon.EC2.Model.PrivateIpAddress[])"> <summary> Sets private IP addresses. </summary> <param name="privateIpAddresses">Private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.IsSetPrivateIpAddresses"> <summary> Checks if the PrivateIpAddresses property is set </summary> <returns>true if the PrivateIpAddresses property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.WithSecondaryPrivateIpAddressCount(System.Int32)"> <summary> Sets the number of secondary private IP addresses. </summary> <param name="secondaryPrivateIpAddressCount">Number of secondary private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceRequest.IsSetSecondaryPrivateIpAddressCount"> <summary> Checks if the SecondaryPrivateIpAddressCount property is set </summary> <returns>true if the SecondaryPrivateIpAddressCount property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.SubnetId"> <summary> The ID of the subnet to associate with the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.Description"> <summary> The description of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.PrivateIpAddress"> <summary> The primary private IP address of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.GroupId"> <summary> A list of security group IDs for use by the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.PrivateIpAddresses"> <summary> Private IP addresses. </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.SecondaryPrivateIpAddressCount"> <summary> Number of secondary private IP addresses. </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkInterfaceResponse"> <summary> Create Network Interface response </summary> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceResponse.IsSetCreateNetworkInterfaceResult"> <summary> Checks if CreateNetworkInterfaceResult property is set </summary> <returns>true if CreateNetworkInterfaceResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceResponse.CreateNetworkInterfaceResult"> <summary> Gets and sets the CreateNetworkInterfaceResult property. </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkInterfaceResult"> <summary> Create Network Interface result </summary> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceResult.IsSetNetworkInterface"> <summary> Checks if NetworkInterface property is set </summary> <returns>true if NetworkInterface property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateNetworkInterfaceResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceResult.NetworkInterface"> <summary> Gets and sets the NetworkInterface property. </summary> </member> <member name="T:Amazon.EC2.Model.CreatePlacementGroupRequest"> <summary> Creates a PlacementGroup into which multiple Amazon EC2 instances can be launched. Users must give the group a name unique within the scope of the user account. </summary> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupRequest.WithGroupName(System.String)"> <summary> Sets the name of the PlacementGroup. </summary> <param name="groupName">The name of the PlacementGroup.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupRequest.WithStrategy(System.String)"> <summary> Sets the placement group strategy. </summary> <param name="strategy">The PlacementGroup strategy.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupRequest.IsSetStrategy"> <summary> Checks if Strategy property is set </summary> <returns>true if Strategy property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreatePlacementGroupRequest.GroupName"> <summary> The name of the PlacementGroup. </summary> </member> <member name="P:Amazon.EC2.Model.CreatePlacementGroupRequest.Strategy"> <summary> The placement group strategy. </summary> <remarks> Valid values: cluster </remarks> </member> <member name="T:Amazon.EC2.Model.CreatePlacementGroupResponse"> <summary> Information returned by the CreatePlacementGroup request. </summary> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreatePlacementGroupResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CreateReservedInstancesListingRequest"> <summary> Creates a new listing for Amazon EC2 Reserved Instances that will be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. </summary> <remarks> 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. If you want 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 you want to receive for them. Your Reserved Instance listings then become available for purchase. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.WithReservedInstancesId(System.String)"> <summary> Sets the ID of the Reserved Instance that will be listed. </summary> <param name="reservedInstancesId">Id of the ReservedInstance</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.IsSetReservedInstancesId"> <summary> Checks if the ReservedInstancesId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.WithInstanceCount(System.Int32)"> <summary> Sets the number of instances that are a part of a Reserved Instance account that will be listed in the Reserved Instance Marketplace. </summary> <param name="instanceCount">Number of instances to list</param> <returns>this instance</returns> <remarks> This number should be less or equal to the instance count associated with the Reserved Instance ID specified in the request. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.IsSetInstanceCount"> <summary> Checks if the InstanceCount property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.WithPricingSchedules(Amazon.EC2.Model.PricingSchedule[])"> <summary> Sets the price listed for the Reserved Instance. </summary> <param name="list">Price to be listed</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.IsSetPricingSchedules"> <summary> Checks if the PricingSchedules property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.WithClientToken(System.String)"> <summary> Sets a unique, case-sensitive identifier you provide to ensure idempotency of your listings. </summary> <param name="clientToken">Identifier</param> <returns>this instance</returns> <remarks> This helps avoid duplicate listings. For more information, see 'Ensuring Idempotency' in the Amazon Elastic Compute Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingRequest.IsSetClientToken"> <summary> Checks if the ClientToken property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.ReservedInstancesId"> <summary> The ID of the Reserved Instance that will be listed. </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.InstanceCount"> <summary> The number of instances that are a part of a Reserved Instance account that will be listed in the Reserved Instance Marketplace. </summary> <remarks> This number should be less or equal to the instance count associated with the Reserved Instance ID specified in the request. </remarks> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.PricingSchedules"> <summary> A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term. </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.ClientToken"> <summary> A unique, case-sensitive identifier you provide to ensure idempotency of your listings. </summary> <remarks> This helps avoid duplicate listings. For more information, see 'Ensuring Idempotency' in the Amazon Elastic Compute Cloud User Guide. </remarks> </member> <member name="T:Amazon.EC2.Model.CreateReservedInstancesListingResponse"> <summary> Create Reserved Instances Listing response from the service </summary> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingResponse.IsSetCreateReservedInstancesListingResult"> <summary> Checks if CreateReservedInstancesListingResult property is set </summary> <returns>true if CreateReservedInstancesListingResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingResponse.CreateReservedInstancesListingResult"> <summary> Gets and sets the CreateReservedInstancesListingResult property. </summary> </member> <member name="T:Amazon.EC2.Model.CreateReservedInstancesListingResult"> <summary> Create Reserved Instances Listing Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingResult.IsSetReservedInstancesListings"> <summary> Checks if ReservedInstancesListings property is set </summary> <returns>true if ReservedInstancesListings property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateReservedInstancesListingResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingResult.ReservedInstancesListings"> <summary> The Reserved Instances listing that was created. </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteRequest"> <summary> Creates a new route in a route table within a VPC. The route's target can be either a gateway attached to the VPC or a NAT instance in the VPC. </summary> <remarks> 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 192.0.2.3, and the route table includes the following two routes: 192.0.2.0/24 (goes to some target A) 192.0.2.0/28 (goes to some target B) Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list is more specific, so we use that route to determine where to target the traffic. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.WithRouteTableId(System.String)"> <summary> Sets the ID of the route table where the route will be added. </summary> <param name="routeTableId">The ID of the route table where the route will be added.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.WithDestinationCidrBlock(System.String)"> <summary> Sets the CIDR address block used for the destination match. </summary> <param name="destinationCidrBlock">The CIDR address block used for the destination match. For example: 0.0.0.0/0. Routing decisions are based on the most specific match.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.IsSetDestinationCidrBlock"> <summary> Checks if DestinationCidrBlock property is set </summary> <returns>true if DestinationCidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.WithGatewayId(System.String)"> <summary> Sets the ID of a gateway attached to your VPC. </summary> <param name="gatewayId">The ID of a gateway attached to your VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.IsSetGatewayId"> <summary> Checks if GatewayId property is set </summary> <returns>true if GatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.WithInstanceId(System.String)"> <summary> Sets the ID of a NAT instance in your VPC. </summary> <param name="instanceId">The ID of a NAT instance in your VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the network interface id. </summary> <param name="networkInterfaceId">Network interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.WithVpcPeeringConnectionId(System.String)"> <summary> Sets the VpcPeeringConnectionId <param name="vpcPeeringConnectionId">The VpcPeeringConnectionId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteRequest.IsSetVpcPeeringConnectionId"> <summary> Checks if VpcPeeringConnectionId is set </summary> <returns>true if VpcPeeringConnectionId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.RouteTableId"> <summary> The ID of the route table where the route will be added. </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.DestinationCidrBlock"> <summary> The CIDR address block used for the destination match. </summary> <remarks> For example: 0.0.0.0/0. Routing decisions are based on the most specific match. </remarks> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.GatewayId"> <summary> The ID of a gateway attached to your VPC. </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.InstanceId"> <summary> The ID of a NAT instance in your VPC. </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.NetworkInterfaceId"> <summary> Allows the routing of network interface IDs. <remarks> Exactly one interface must be attached when specifying an instance ID or it fails. Value provided must be one of the following: GatewayID, InstanceID, or NetworkdInterfaceId. </remarks> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.VpcPeeringConnectionId"> <summary> The ID of a VPC peering connection. </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteResponse"> <summary> The Response for the CreateRoute operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateRouteResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateRouteResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteTableRequest"> <summary> Creates a route table within a VPC. After you create a new route table, you can add routes and associate the table with a subnet. </summary> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC. </summary> <param name="vpcId">The ID of the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateRouteTableRequest.VpcId"> <summary> The ID of the VPC. </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteTableResponse"> <summary> The Response for the CreateRouteTable operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableResponse.IsSetCreateRouteTableResult"> <summary> Checks if CreateRouteTableResult property is set </summary> <returns>true if CreateRouteTableResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateRouteTableResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteTableResponse.CreateRouteTableResult"> <summary> Gets and sets the CreateRouteTableResult property. CreateRouteTable Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteTableResult"> <summary> CreateRouteTable Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableResult.IsSetRouteTable"> <summary> Checks if RouteTable property is set </summary> <returns>true if RouteTable property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateRouteTableResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateRouteTableResult.RouteTable"> <summary> Gets and sets the RouteTable property. Information about the newly created route table. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSecurityGroupRequest"> <summary> Creates a new security group. Group names must be unique per account. </summary> <remarks> Every instance is launched in a security group. If no security group is specified during launch, the instances are launched in the default security group. Instances within the same security group have unrestricted network access to each other. Instances will reject network access attempts from other instances in a different security group. As the owner of instances you can grant or revoke specific permissions using the AuthorizeSecurityGroupIngress and RevokeSecurityGroupIngress operations. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.WithGroupName(System.String)"> <summary> Sets the name of the security group. </summary> <param name="groupName">Name of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.WithGroupDescription(System.String)"> <summary> Sets the description of the group. </summary> <param name="groupDescription">Description of the group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.IsSetGroupDescription"> <summary> Checks if GroupDescription property is set </summary> <returns>true if GroupDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC. </summary> <param name="vpcId">ID of the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupRequest.GroupName"> <summary> Name of the security group. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupRequest.GroupDescription"> <summary> Description of the group. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupRequest.VpcId"> <summary> ID of the VPC. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSecurityGroupResponse"> <summary> Create Security Group Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupResponse.IsSetCreateSecurityGroupResult"> <summary> Checks if CreateSecurityGroupResult property is set </summary> <returns>true if CreateSecurityGroupResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupResponse.CreateSecurityGroupResult"> <summary> Gets and sets the CreateSecurityGroupResult property. CreateSecurityGroup Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateSecurityGroupResult"> <summary> CreateSecurityGroup Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupResult.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupResult.GroupId"> <summary> Gets and sets the GroupId property. ID that AWS assigns to the security group. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSnapshotRequest"> <summary> Container for the parameters to the CreateSnapshot operation. <para>Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.</para> <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 Amazon 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 writes to 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 <c>pending</c> .</para> <para>To create a snapshot for Amazon 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> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotRequest.WithVolumeId(System.String)"> <summary> Sets the ID of the Amazon EBS volume of which to take a snapshot. </summary> <param name="volumeId">The ID of the Amazon EBS volume of which to take a snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotRequest.WithDescription(System.String)"> <summary> Sets the description of the Amazon EBS snapshot. </summary> <param name="description">Description of the Amazon EBS snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotRequest.VolumeId"> <summary> The ID of the Amazon EBS volume of which to take a snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotRequest.Description"> <summary> Description of the Amazon EBS snapshot. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSnapshotResponse"> <summary> Create Snapshot Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotResponse.IsSetCreateSnapshotResult"> <summary> Checks if CreateSnapshotResult property is set </summary> <returns>true if CreateSnapshotResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotResponse.CreateSnapshotResult"> <summary> Gets and sets the CreateSnapshotResult property. Create Snapshot Result </summary> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CreateSnapshotResult"> <summary> Create Snapshot Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotResult.IsSetSnapshot"> <summary> Checks if Snapshot property is set </summary> <returns>true if Snapshot property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotResult.Snapshot"> <summary> Gets and sets the Snapshot property. Snapshot </summary> </member> <member name="T:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest"> <summary> Creates the datafeed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per account. </summary> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.WithBucket(System.String)"> <summary> Sets the Amazon S3 bucket in which to store the Spot Instance datafeed. </summary> <param name="bucket"> The Amazon S3 bucket in which to store the Spot Instance datafeed. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.IsSetBucket"> <summary> Checks if Bucket property is set </summary> <returns>true if Bucket property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.WithPrefix(System.String)"> <summary> Sets the prefix that is prepended to datafeed files. </summary> <param name="prefix">Prefix that is prepended to datafeed files.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.IsSetPrefix"> <summary> Checks if Prefix property is set </summary> <returns>true if Prefix property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.Bucket"> <summary> The Amazon S3 bucket in which to store the Spot Instance datafeed. Constraints: Must be a valid bucket assocaited with your account. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.Prefix"> <summary> Prefix that is prepended to datafeed files. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse"> <summary> The Response for the CreateSpotDatafeedSubscription operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse.IsSetCreateSpotDatafeedSubscriptionResult"> <summary> Checks if CreateSpotDatafeedSubscriptionResult property is set </summary> <returns>true if CreateSpotDatafeedSubscriptionResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse.CreateSpotDatafeedSubscriptionResult"> <summary> Gets and sets the CreateSpotDatafeedSubscriptionResult property. Create Spot Datafeed Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResult"> <summary> Create Spot Datafeed Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResult.IsSetSpotDatafeedSubscription"> <summary> Checks if SpotDatafeedSubscription property is set </summary> <returns>true if SpotDatafeedSubscription property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResult.SpotDatafeedSubscription"> <summary> Gets and sets the SpotDatafeedSubscription property. Describes the Spot Datafeed subscription. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSubnetRequest"> <summary> Creates a subnet in an existing VPC. </summary> <remarks> You can create up to 20 subnets in a VPC. 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. If you feel you need more than 20 subnets, you can request more by going to http://aws.amazon.com/contact-us/vpc-request/. When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. Once 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 /18 netmask (16,384 IP addresses). *Important* AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. AWS might delete any subnet you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet). </remarks> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC where you want to create the subnet. </summary> <param name="vpcId">The ID of the VPC where you want to create the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.WithCidrBlock(System.String)"> <summary> Sets the CIDR block you want the subnet to cover. </summary> <param name="cidrBlock">The CIDR block you want the subnet to cover.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.IsSetCidrBlock"> <summary> Checks if CidrBlock property is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone you want the subnet in. </summary> <param name="availabilityZone">The Availability Zone you want the subnet in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateSubnetRequest.VpcId"> <summary> The ID of the VPC where you want to create the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSubnetRequest.CidrBlock"> <summary> The CIDR block you want the subnet to cover. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSubnetRequest.AvailabilityZone"> <summary> The Availability Zone you want the subnet in. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSubnetResponse"> <summary> Create Subnet Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateSubnetResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetResponse.IsSetCreateSubnetResult"> <summary> Checks if CreateSubnetResult property is set </summary> <returns>true if CreateSubnetResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSubnetResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateSubnetResponse.CreateSubnetResult"> <summary> Gets and sets the CreateSubnetResult property. Create Subnet Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateSubnetResult"> <summary> Create Subnet Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateSubnetResult.IsSetSubnet"> <summary> Checks if Subnet property is set </summary> <returns>true if Subnet property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateSubnetResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateSubnetResult.Subnet"> <summary> Gets and sets the Subnet property. Subnet </summary> </member> <member name="T:Amazon.EC2.Model.CreateTagsRequest"> <summary> Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags. Each tag consists of a key-value pair. Tag keys must be unique per resource. </summary> </member> <member name="M:Amazon.EC2.Model.CreateTagsRequest.WithResourceId(System.String[])"> <summary> Sets the IDs of resources to tag. </summary> <param name="list">One or more IDs of resources to tag.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateTagsRequest.IsSetResourceId"> <summary> Checks if ResourceId property is set </summary> <returns>true if ResourceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateTagsRequest.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags to add or overwrite for the specified resources. </summary> <param name="list">The tags to add or overwrite for the specified resources. Each tag item consists of a key-value pair.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateTagsRequest.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateTagsRequest.ResourceId"> <summary> One or more IDs of resources to tag. </summary> </member> <member name="P:Amazon.EC2.Model.CreateTagsRequest.Tag"> <summary> The tags to add or overwrite for the specified resources. Each tag item consists of a key-value pair. </summary> </member> <member name="T:Amazon.EC2.Model.CreateTagsResponse"> <summary> The Response for the CreateTagsResponse operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateTagsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateTagsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateTagsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateTagsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumePermission"> <summary> Permissions for creating a volume. </summary> </member> <member name="M:Amazon.EC2.Model.CreateVolumePermission.WithUserId(System.String)"> <summary> Sets the user ID of a user that can create volumes from the snapshot. </summary> <param name="userId">User ID of a user that can create volumes from the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumePermission.IsSetUserId"> <summary> Checks if UserId property is set </summary> <returns>true if UserId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumePermission.WithGroupName(System.String)"> <summary> Sets the group that is allowed to create volumes from the snapshot (currently supports "all"). </summary> <param name="groupName">Group that is allowed to create volumes from the snapshot (currently supports "all").</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumePermission.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateVolumePermission.UserId"> <summary> User ID of a user that can create volumes from the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumePermission.GroupName"> <summary> Group that is allowed to create volumes from the snapshot (currently supports "all"). </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumeRequest"> <summary> Container for the parameters to the CreateVolume operation. <para>Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the specified region.</para> <para>You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.</para> <para>You can create encrypted volumes with the <c>Encrypted</c> 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> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.WithSize(System.String)"> <summary> Sets the size of the volume, in GiBs. </summary> <param name="size">The size of the volume, in GiBs. Required if you are not creating a volume from a snapshot. Valid Values: 1-1024</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.IsSetSize"> <summary> Checks if Size property is set </summary> <returns>true if Size property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.WithSnapshotId(System.String)"> <summary> Sets the snapshot from which to create the new volume. </summary> <param name="snapshotId">The snapshot from which to create the new volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone in which to create the new volume. </summary> <param name="availabilityZone">The Availability Zone in which to create the new volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.WithIOPS(System.String)"> <summary> Sets the number of I/O operations per second (IOPS) that the volume supports. </summary> <param name="iops">Quantity of desired throughput in IOPS</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.IsSetIOPS"> <summary> Checks if IOPS property is set </summary> <returns>True if IOPS property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.WithVolumeType(System.String)"> <summary> Sets the volume type. </summary> <param name="volumeType">Volume Type. Constraints: may be either "io1" or "standard". If VolumeType != "io1", IOPS property cannot be set. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.IsSetVolumeType"> <summary> Checks if VolumeType property is set </summary> <returns>True if VolumeType property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.Size"> <summary> The size of the volume, in GiBs. Required if you are not creating a volume from a snapshot. Valid Values: 1-1024 </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.SnapshotId"> <summary> The snapshot from which to create the new volume. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.AvailabilityZone"> <summary> The Availability Zone in which to create the new volume. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.IOPS"> <summary> The number of I/O operations per second (IOPS) that the volume supports. Range is 100 to 1000. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.VolumeType"> <summary> The volume type. Value may be either "io1" or "standard". If VolumeType != "io1", IOPS property cannot be set. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumeResponse"> <summary> Create Volume Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateVolumeResponse.IsSetCreateVolumeResult"> <summary> Checks if CreateVolumeResult property is set </summary> <returns>true if CreateVolumeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVolumeResponse.CreateVolumeResult"> <summary> Gets and sets the CreateVolumeResult property. Create Volume Result </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumeResult"> <summary> Create Volume Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateVolumeResult.IsSetVolume"> <summary> Checks if Volume property is set </summary> <returns>true if Volume property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVolumeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVolumeResult.Volume"> <summary> Gets and sets the Volume property. Volume </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest"> <summary> Container for the parameters to the DeleteVolume operation. <para>Deletes the specified Amazon EBS volume. The volume must be in the <c>available</c> state (not attached to an instance).</para> <para><b>NOTE:</b> The volume may remain in the deleting state for several minutes. </para> <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> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.WithVpcId(System.String)"> <summary> Sets the VpcId <param name="vpcId">The VpcId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.IsSetVpcId"> <summary> Checks if VpcId is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.WithPeerVpcId(System.String)"> <summary> Sets the PeerVpcId <param name="peerVpcId">The PeerVpcId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.IsSetPeerVpcId"> <summary> Checks if PeerVpcId is set </summary> <returns>true if PeerVpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.WithPeerOwnerId(System.String)"> <summary> Sets the PeerOwnerId <param name="peerOwnerId">The PeerOwnerId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.IsSetPeerOwnerId"> <summary> Checks if PeerOwnerId is set </summary> <returns>true if PeerOwnerId property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.VpcId"> <summary> The ID of the requester VPC. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.PeerVpcId"> <summary> The ID of the VPC with which you are creating the VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.PeerOwnerId"> <summary> The AWS account ID of the owner of the peer VPC. Default: Your AWS account ID </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse"> <summary> The Response for the CreateVpcPeeringConnection operation. </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse.IsSetCreateVpcPeeringConnectionResult"> <summary> Checks if CreateVpcPeeringConnectionResult property is set </summary> <returns>true if CreateVpcPeeringConnectionResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse.CreateVpcPeeringConnectionResult"> <summary> Gets and sets the CreateVpcPeeringConnectionResult property. </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionResult.WithVpcPeeringConnection(Amazon.EC2.Model.VpcPeeringConnection)"> <summary> Sets the VpcPeeringConnection <param name="vpcPeeringConnection">The VpcPeeringConnection.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcPeeringConnectionResult.IsSetVpcPeeringConnection"> <summary> Checks if VpcPeeringConnection is set </summary> <returns>true if VpcPeeringConnection property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionResult.VpcPeeringConnection"> <summary> Information about the VPC peering connection. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcRequest"> <summary> Creates a VPC with the CIDR block you specify. </summary> <remarks> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /18 netmask (16,384 IP addresses). To help you decide how big to make your VPC, go to the topic about creating VPCs in the Amazon Virtual Private Cloud Developer Guide. By default, each instance you launch in the VPC has the default DHCP options (the standard EC2 host name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type). AWS might delete any VPC that you create with this operation if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC). </remarks> </member> <member name="M:Amazon.EC2.Model.CreateVpcRequest.WithCidrBlock(System.String)"> <summary> Sets the CIDR block you want the VPC to cover (e.g., 10.0.0.0/16) </summary> <param name="cidrBlock">A valid CIDR block. Constraints: Must contain the slash followed by one or two digits (e.g., /28)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcRequest.IsSetCidrBlock"> <summary> Checks if CidrBlock property is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcRequest.IsSetInstanceTenancy"> <summary> Checks if InstanceTenancy property is set </summary> <returns>true if InstanceTenancy property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcRequest.WithInstanceTenancy(System.String)"> <summary> Sets the supported tenancy of instances launched into the VPC. </summary> <param name="instanceTenancy">The allowed tenancy of instances launched into the VPC.</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpcRequest.CidrBlock"> <summary> The CIDR block you want the VPC to cover (e.g., 10.0.0.0/16) </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcRequest.InstanceTenancy"> <summary> The supported tenancy of instances launched into the VPC. </summary> <remarks> A value of "default" means instances can be launched with any tenancy; a value of "dedicated" means all instances launched into the VPC will be launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Setting the instance's tenancy attribute to dedicated specifies that your instance will run on single-tenant hardware. </remarks> </member> <member name="T:Amazon.EC2.Model.CreateVpcResponse"> <summary> Create Vpc Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpcResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcResponse.IsSetCreateVpcResult"> <summary> Checks if CreateVpcResult property is set </summary> <returns>true if CreateVpcResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpcResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcResponse.CreateVpcResult"> <summary> Gets and sets the CreateVpcResult property. Create Vpc Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcResult"> <summary> Create Vpc Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpcResult.IsSetVpc"> <summary> Checks if Vpc property is set </summary> <returns>true if Vpc property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpcResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpcResult.Vpc"> <summary> Gets and sets the Vpc property. VPC </summary> </member> <member name="T: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 ipsec.1. </summary> <remarks> The response includes information that you need to configure your customer gateway, in XML format. It is strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. If you 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 CreateVpnConnection. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.WithType(System.String)"> <summary> Sets the type of VPN connection. </summary> <param name="type">The type of VPN connection</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.WithCustomerGatewayId(System.String)"> <summary> Sets the ID of the customer gateway. </summary> <param name="customerGatewayId">The ID of the customer gateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.IsSetCustomerGatewayId"> <summary> Checks if CustomerGatewayId property is set </summary> <returns>true if CustomerGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.WithVpnGatewayId(System.String)"> <summary> Sets the ID of the VPN gateway. </summary> <param name="vpnGatewayId">The ID of the VPN gateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.IsSetVpnGatewayId"> <summary> Checks if VpnGatewayId property is set </summary> <returns>true if VpnGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.WithStaticRoutesOnly(System.Boolean)"> <summary> Sets whether or not the VPN connection requires static routes. </summary> <param name="staticRoutesOnly">Static routes only value</param> <returns>This instance</returns> <remarks> A Boolean value indicating whether or not the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify this value as true. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.IsSetStaticRoutesOnly"> <summary> Checks if the StaticRoutesOnly property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.Type"> <summary> The type of VPN connection. The only supported connection type is ipsec.1. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.CustomerGatewayId"> <summary> The ID of the customer gateway. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.VpnGatewayId"> <summary> The ID of the VPN gateway. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.StaticRoutesOnly"> <summary> Whether or not the VPN connection requires static routes. </summary> <remarks> If you are creating a VPN connection for a device that does not support BGP, you must specify this value as true. </remarks> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionResponse"> <summary> Create Vpn Connection Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionResponse.IsSetCreateVpnConnectionResult"> <summary> Checks if CreateVpnConnectionResult property is set </summary> <returns>true if CreateVpnConnectionResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionResponse.CreateVpnConnectionResult"> <summary> Gets and sets the CreateVpnConnectionResult property. Create Vpn Connection Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionResult"> <summary> Create Vpn Connection Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionResult.IsSetVpnConnection"> <summary> Checks if VpnConnection property is set </summary> <returns>true if VpnConnection property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionResult.VpnConnection"> <summary> Gets and sets the VpnConnection property. Vpn connection </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionRouteRequest"> <summary> Creates a new 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> <remarks> We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </remarks> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.WithVpnConnectionId(System.String)"> <summary> Sets the ID of the VPN connection. </summary> <param name="vpnConnectionId">ID of the VPN connection</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.IsSetVpnConnectionId"> <summary> Checks if the VpnConnectionId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.WithDestinationCidrBlock(System.String)"> <summary> Sets the CIDR block associated with local subnet of the customer data center. </summary> <param name="destinationCidrBlock">CIDR</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.IsSetDestinationCidrBlock"> <summary> Checks if the DestinationCidrBlock property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.VpnConnectionId"> <summary> The ID of the VPN connection. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.DestinationCidrBlock"> <summary> The CIDR block associated with local subnet of the customer data center. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionRouteResponse"> <summary> CreateVpnConnectionRoute Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRouteResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRouteResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRouteResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRouteResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnGatewayRequest"> <summary> Creates a new VPN gateway. </summary> <remarks> A VPN gateway is the VPC-side endpoint for your VPN connection. You can create a VPN gateway before creating the VPC itself. AWS might delete any VPN gateway that you create with this operation if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway) </remarks> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayRequest.WithType(System.String)"> <summary> Sets the type of VPN connection this VPN gateway supports. </summary> <param name="type">The type of VPN connection this VPN gateway supports. The only supported type is ipsec.1.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayRequest.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayRequest.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone where you want the VPN gateway. </summary> <param name="availabilityZone">The Availability Zone where you want the VPN gateway. Default: AWS selects a zone for you (recommended)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayRequest.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayRequest.Type"> <summary> The type of VPN connection this VPN gateway supports. The only supported type is ipsec.1. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayRequest.AvailabilityZone"> <summary> The Availability Zone where you want the VPN gateway. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnGatewayResponse"> <summary> Create Vpn Gateway Response </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayResponse.IsSetCreateVpnGatewayResult"> <summary> Checks if CreateVpnGatewayResult property is set </summary> <returns>true if CreateVpnGatewayResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayResponse.CreateVpnGatewayResult"> <summary> Gets and sets the CreateVpnGatewayResult property. Create Vpn Gateway Result </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnGatewayResult"> <summary> Create Vpn Gateway Result </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayResult.IsSetVpnGateway"> <summary> Checks if VpnGateway property is set </summary> <returns>true if VpnGateway property is set</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayResult.VpnGateway"> <summary> Gets and sets the VpnGateway property. Vpn gateway </summary> </member> <member name="T:Amazon.EC2.Model.CustomerGateway"> <summary> Customer Gateway </summary> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.WithCustomerGatewayId(System.String)"> <summary> Sets the ID of the customer gateway </summary> <param name="customerGatewayId">The ID of the customer gateway</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.IsSetCustomerGatewayId"> <summary> Checks if CustomerGatewayId property is set </summary> <returns>true if CustomerGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.WithCustomerGatewayState(System.String)"> <summary> Sets the current state of the customer gateway. </summary> <param name="customerGatewayState">The current state of the customer gateway (pending, available, deleting, deleted)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.IsSetCustomerGatewayState"> <summary> Checks if CustomerGatewayState property is set </summary> <returns>true if CustomerGatewayState property is set</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.WithType(System.String)"> <summary> Sets the type of VPN connection the customer gateway supports. </summary> <param name="type">The type of VPN connection the customer gateway supports (ipsec.1).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.WithIpAddress(System.String)"> <summary> Sets the Internet-routable IP address of the customer gateway's outside interface </summary> <param name="ipAddress">The Internet-routable IP address of the customer gateway's outside interface</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.IsSetIpAddress"> <summary> Checks if IpAddress property is set </summary> <returns>true if IpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.WithBgpAsn(System.String)"> <summary> Sets the customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). </summary> <param name="bgpAsn">The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.IsSetBgpAsn"> <summary> Checks if BgpAsn property is set </summary> <returns>true if BgpAsn property is set</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the list of tags for the CustomerGateway. </summary> <param name="list">A list of tags for the CustomerGateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.CustomerGateway.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.CustomerGatewayId"> <summary> The ID of the customer gateway </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.CustomerGatewayState"> <summary> The current state of the customer gateway (pending, available, deleting, deleted) </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.Type"> <summary> The type of VPN connection the customer gateway supports (ipsec.1). </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.IpAddress"> <summary> The Internet-routable IP address of the customer gateway's outside interface </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.BgpAsn"> <summary> The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.Tag"> <summary> List of tags for the CustomerGateway. </summary> </member> <member name="T:Amazon.EC2.Model.DeactivateLicenseRequest"> <summary> Deactivates a specific number of licenses. </summary> <remarks> Deactivations can be done against a specific license ID after they have persisted for at least a 90-day period. </remarks> </member> <member name="M:Amazon.EC2.Model.DeactivateLicenseRequest.WithLicenseId(System.String)"> <summary> Sets the license ID. </summary> <param name="licenseId">LicenseId property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeactivateLicenseRequest.IsSetLicenseId"> <summary> Checks if LicenseId property is set </summary> <returns>true if LicenseId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeactivateLicenseRequest.WithCapacity(System.Decimal)"> <summary> Sets the Capacity. </summary> <param name="capacity">Capacity property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeactivateLicenseRequest.IsSetCapacity"> <summary> Checks if Capacity property is set </summary> <returns>true if Capacity property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeactivateLicenseRequest.LicenseId"> <summary> License ID. </summary> </member> <member name="P:Amazon.EC2.Model.DeactivateLicenseRequest.Capacity"> <summary> Capacity. </summary> </member> <member name="T:Amazon.EC2.Model.DeactivateLicenseResponse"> <summary> Deactivates a license. </summary> </member> <member name="M:Amazon.EC2.Model.DeactivateLicenseResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeactivateLicenseResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeactivateLicenseResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeactivateLicenseResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteCustomerGatewayRequest"> <summary> Deletes a customer gateway. </summary> <remarks> You must delete the VPN connection before deleting the customer gateway. AWS might delete any customer gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the customer gateway). </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteCustomerGatewayRequest.WithCustomerGatewayId(System.String)"> <summary> Sets the ID of the customer gateway you want to delete. </summary> <param name="customerGatewayId">The ID of the customer gateway you want to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteCustomerGatewayRequest.IsSetCustomerGatewayId"> <summary> Checks if CustomerGatewayId property is set </summary> <returns>true if CustomerGatewayId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteCustomerGatewayRequest.CustomerGatewayId"> <summary> The ID of the customer gateway you want to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteCustomerGatewayResponse"> <summary> Delete Customer Gateway Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteCustomerGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteCustomerGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteCustomerGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteCustomerGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteDhcpOptionsRequest"> <summary> Deletes a set of DHCP options that you specify. </summary> <remarks> Amazon VPC returns an error if the set of options you specify is currently associated with a VPC. You can disassociate the set of options by associating either a new set of options or the default options with the VPC. </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteDhcpOptionsRequest.WithDhcpOptionsId(System.String)"> <summary> Sets the ID of the DHCP options set you want to delete. </summary> <param name="dhcpOptionsId">The ID of the DHCP options set you want to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteDhcpOptionsRequest.IsSetDhcpOptionsId"> <summary> Checks if DhcpOptionsId property is set </summary> <returns>true if DhcpOptionsId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteDhcpOptionsRequest.DhcpOptionsId"> <summary> The ID of the DHCP options set you want to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteDhcpOptionsResponse"> <summary> Delete Dhcp Options Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteDhcpOptionsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteDhcpOptionsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteDhcpOptionsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteDhcpOptionsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteInternetGatewayRequest"> <summary> Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteInternetGatewayRequest.WithInternetGatewayId(System.String)"> <summary> Sets the ID of the Internet gateway to be deleted. </summary> <param name="internetGatewayId">The ID of the Internet gateway to be deleted.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteInternetGatewayRequest.IsSetInternetGatewayId"> <summary> Checks if InternetGatewayId property is set </summary> <returns>true if InternetGatewayId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteInternetGatewayRequest.InternetGatewayId"> <summary> The ID of the Internet gateway to be deleted. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteInternetGatewayResponse"> <summary> The Response for the DeleteInternetGateway operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteInternetGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteInternetGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteInternetGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteInternetGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteKeyPairRequest"> <summary> Deletes the specified key pair, by removing the public key from Amazon EC2. You must own the key pair. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteKeyPairRequest.WithKeyName(System.String)"> <summary> Sets the name of the key pair to delete. </summary> <param name="keyName">Name of the key pair to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteKeyPairRequest.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteKeyPairRequest.KeyName"> <summary> Name of the key pair to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteKeyPairResponse"> <summary> Delete Key Pair Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteKeyPairResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteKeyPairResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteKeyPairResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteKeyPairResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkAclEntryRequest"> <summary> Deletes an ingress or egress entry (i.e., rule) from a network ACL. </summary> <remarks> For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.WithNetworkAclId(System.String)"> <summary> Sets the ID of the network ACL. </summary> <param name="networkAclId">ID of the network ACL.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.WithRuleNumber(System.Decimal)"> <summary> Sets the rule number for the entry to delete. </summary> <param name="ruleNumber">Rule number for the entry to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.IsSetRuleNumber"> <summary> Checks if RuleNumber property is set </summary> <returns>true if RuleNumber property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.WithEgress(System.Boolean)"> <summary> Sets whether the rule to delete is an egress rule (true) or ingress rule (false). </summary> <param name="egress">Whether the rule to delete is an egress rule (true) or ingress rule (false).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.IsSetEgress"> <summary> Checks if Egress property is set </summary> <returns>true if Egress property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.NetworkAclId"> <summary> ID of the network ACL. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.RuleNumber"> <summary> Rule number for the entry to delete. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.Egress"> <summary> Whether the rule to delete is an egress rule (true) or ingress rule (false). </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkAclEntryResponse"> <summary> The Response for the DeleteNetworkAclEntry operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclEntryResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclEntryResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkAclRequest"> <summary> Deletes a network ACL from a VPC. </summary> <remarks> The ACL must not have any subnets associated with it. You can't delete the default network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclRequest.WithNetworkAclId(System.String)"> <summary> Sets the ID of the network ACL to be deleted. </summary> <param name="networkAclId">The ID of the network ACL to be deleted.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclRequest.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclRequest.NetworkAclId"> <summary> The ID of the network ACL to be deleted. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkAclResponse"> <summary> The Response for the DeleteNetworkAcl operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkAclResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkInterfaceRequest"> <summary> Deletes the specified network interface. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkInterfaceRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface to delete. </summary> <param name="networkInterfaceId">The network interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkInterfaceRequest.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkInterfaceRequest.NetworkInterfaceId"> <summary> The ID of the network interface to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkInterfaceResponse"> <summary> Delete Network Interface response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkInterfaceResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkInterfaceResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteNetworkInterfaceResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkInterfaceResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeletePlacementGroupRequest"> <summary> Deletes a PlacementGroupfrom a user's account. Terminate all Amazon EC2 instances in the placement group before deletion. </summary> </member> <member name="M:Amazon.EC2.Model.DeletePlacementGroupRequest.WithGroupName(System.String)"> <summary> Sets the name of the PlacementGroup to delete. </summary> <param name="groupName">The name of the PlacementGroup to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeletePlacementGroupRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeletePlacementGroupRequest.GroupName"> <summary> The name of the PlacementGroup to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeletePlacementGroupResponse"> <summary> Information returned by the DeletePlacementGroup request. </summary> </member> <member name="M:Amazon.EC2.Model.DeletePlacementGroupResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeletePlacementGroupResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeletePlacementGroupResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeletePlacementGroupResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteRouteRequest"> <summary> Deletes a route from a route table in a VPC. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteRouteRequest.WithRouteTableId(System.String)"> <summary> Sets the ID of the route table where the route will be deleted. </summary> <param name="routeTableId">The ID of the route table where the route will be deleted.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteRequest.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteRequest.WithDestinationCidrBlock(System.String)"> <summary> Sets the CIDR range for the route you want to delete. </summary> <param name="destinationCidrBlock">The CIDR range for the route you want to delete. The value you specify must exactly match the CIDR for the route you want to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteRequest.IsSetDestinationCidrBlock"> <summary> Checks if DestinationCidrBlock property is set </summary> <returns>true if DestinationCidrBlock property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteRouteRequest.RouteTableId"> <summary> The ID of the route table where the route will be deleted. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteRouteRequest.DestinationCidrBlock"> <summary> The CIDR range for the route you want to delete. The value you specify must exactly match the CIDR for the route you want to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteRouteResponse"> <summary> The Response for the DeleteRoute operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteRouteResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteRouteResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteRouteTableRequest"> <summary> Deletes a route table from a VPC. The route table must not be associated with a subnet. You can't delete the main route table. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteRouteTableRequest.WithRouteTableId(System.String)"> <summary> Sets the RouteTableId property </summary> <param name="routeTableId">The ID of the route table to be deleted.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteTableRequest.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteRouteTableRequest.RouteTableId"> <summary> The ID of the route table to be deleted. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteRouteTableResponse"> <summary> The Response for the DeleteRouteTableResponse operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteRouteTableResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteTableResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteRouteTableResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteRouteTableResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSecurityGroupRequest"> <summary> Deletes a security group that you own. </summary> <remarks> If you attempt to delete a security group that contains instances, an error is returned. If you attempt to delete a security group that is referenced by another security group, an error is returned. For example, if security group B has a rule that allows access from security group A, security group A cannot be deleted until the allow rule is removed. </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupRequest.WithGroupId(System.String)"> <summary> Sets the ID of the security group to delete. </summary> <param name="groupId">ID of the security group to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupRequest.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupRequest.WithGroupName(System.String)"> <summary> Sets the name of the security group to delete. </summary> <param name="groupName">Name of the security group to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteSecurityGroupRequest.GroupId"> <summary> ID of the security group to delete. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteSecurityGroupRequest.GroupName"> <summary> Name of the security group to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSecurityGroupResponse"> <summary> Delete Security Group Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteSecurityGroupResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSnapshotRequest"> <summary> Deletes a snapshot of an Amazon EBS volume that you own. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSnapshotRequest.WithSnapshotId(System.String)"> <summary> Sets the ID of the Amazon EBS snapshot to delete. </summary> <param name="snapshotId">The ID of the Amazon EBS snapshot to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSnapshotRequest.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteSnapshotRequest.SnapshotId"> <summary> The ID of the Amazon EBS snapshot to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSnapshotResponse"> <summary> Delete Snapshot Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSnapshotResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSnapshotResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSnapshotResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteSnapshotResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest"> <summary> Deletes the datafeed for Spot Instances. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionResponse"> <summary> The Response for the DeleteSpotDatafeedSubscription operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSubnetRequest"> <summary> Deletes a subnet from a VPC. </summary> <remarks> You must terminate all running instances in the subnet before deleting it, otherwise Amazon VPC returns an error. AWS might delete any subnet if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the subnet). </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteSubnetRequest.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet you want to delete. </summary> <param name="subnetId">The ID of the subnet you want to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSubnetRequest.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteSubnetRequest.SubnetId"> <summary> The ID of the subnet you want to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSubnetResponse"> <summary> Delete Subnet Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSubnetResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSubnetResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteSubnetResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteSubnetResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteTags"> <summary> Key-value pair representation of a tag. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteTags.WithKey(System.String)"> <summary> Sets the tag's key. </summary> <param name="key">Key property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTags.IsSetKey"> <summary> Checks if Key property is set </summary> <returns>true if Key property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTags.WithValue(System.String)"> <summary> Sets the tag's value. </summary> <param name="value">Value property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTags.IsSetValue"> <summary> Checks if Value property is set </summary> <returns>true if Value property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteTags.Key"> <summary> Tag's key. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteTags.Value"> <summary> Tag's value. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteTagsRequest"> <summary> Deletes tags from the specified resources. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteTagsRequest.WithResourceId(System.String[])"> <summary> Sets the list of one or more resource IDs. </summary> <param name="list">A list of one or more resource IDs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTagsRequest.IsSetResourceId"> <summary> Checks if ResourceId property is set </summary> <returns>true if ResourceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTagsRequest.WithTag(Amazon.EC2.Model.DeleteTags[])"> <summary> Sets the tags to delete from the specified resources. </summary> <param name="list">The tags to delete from the specified resources. Each tag item consists of a key-value pair. If a tag doesn't have a value defined in the key-value pair, the tag is deleted regardless of its value.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTagsRequest.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteTagsRequest.ResourceId"> <summary> A list of one or more resource IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteTagsRequest.Tag"> <summary> The tags to delete from the specified resources. If a tag doesn't have a value defined in the key-value pair, the tag is deleted regardless of its value. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteTagsResponse"> <summary> The Response for the DeleteTags operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteTagsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTagsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteTagsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteTagsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVolumeRequest"> <summary> Deletes an Amazon EBS volume that you own. The volume must be in the available state (not attached to an instance). </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVolumeRequest.WithVolumeId(System.String)"> <summary> Sets the ID of the volume to delete. </summary> <param name="volumeId">The ID of the volume to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVolumeRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVolumeRequest.VolumeId"> <summary> The ID of the volume to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVolumeResponse"> <summary> Delete Volume Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVolumeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVolumeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVolumeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVolumeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest"> <summary> Container for the parameters to the DeleteVpcPeeringConnection operation. <para>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 <c>active</c> state. The owner of the requester VPC can delete a VPC peering connection in the <c>pending-acceptance</c> state.</para> </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest.WithVpcPeeringConnectionId(System.String)"> <summary> Sets the VpcPeeringConnectionId <param name="vpcPeeringConnectionId">The VpcPeeringConnectionId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest.IsSetVpcPeeringConnectionId"> <summary> Checks if VpcPeeringConnectionId is set </summary> <returns>true if VpcPeeringConnectionId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest.VpcPeeringConnectionId"> <summary> The ID of the VPC peering connection. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcPeeringConnectionResponse"> <summary> The Response for the DeleteVpcPeeringConnection operation. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpcPeeringConnectionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpcPeeringConnectionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpcPeeringConnectionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpcPeeringConnectionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcRequest"> <summary> Deletes a VPC. </summary> <remarks> You must terminate all running instances and delete all subnets before deleting the VPC, otherwise Amazon VPC returns an error. AWS might delete any VPC if you leave it inactive for an extended period of time (inactive means that there are no running Amazon EC2 instances in the VPC). </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteVpcRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC you want to delete. </summary> <param name="vpcId">The ID of the VPC you want to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpcRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpcRequest.VpcId"> <summary> The ID of the VPC you want to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcResponse"> <summary> Delete Vpc Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpcResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpcResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpcResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpcResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnConnectionRequest"> <summary> Deletes a VPN connection. </summary> <remarks> This operation will delete a VPC and all its associated components. Another reason to use this operation is if you believe the tunnel credentials for your VPN connection have been compromised. In that situation, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or VPN 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. If you're deleting the VPC and all its associated parts, we recommend you detach the VPN gateway from the VPC and delete the VPC before deleting the VPN connection. </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRequest.WithVpnConnectionId(System.String)"> <summary> Sets the ID of the VPN connection you want to delete. </summary> <param name="vpnConnectionId">The ID of the VPN connection you want to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRequest.IsSetVpnConnectionId"> <summary> Checks if VpnConnectionId property is set </summary> <returns>true if VpnConnectionId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionRequest.VpnConnectionId"> <summary> The ID of the VPN connection you want to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnConnectionResponse"> <summary> Delete Vpn Connection Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest"> <summary> Deletes 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. </summary> <remakrs> We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </remakrs> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.WithVpnConnectionId(System.String)"> <summary> Sets the ID of the VPN connection. </summary> <param name="vpnConnectionId">ID of the VPN connection</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.IsSetVpnConnectionId"> <summary> Checks if the VpnConnectionId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.WithDestinationCidrBlock(System.String)"> <summary> Sets the CIDR block associated with local subnet of the customer data center. </summary> <param name="destinationCidrBlock">CIDR</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.IsSetDestinationCidrBlock"> <summary> Checks if the DestinationCidrBlock property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.VpnConnectionId"> <summary> The ID of the VPN connection. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.DestinationCidrBlock"> <summary> The CIDR block associated with local subnet of the customer data center. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnConnectionRouteResponse"> <summary> Delete Vpn Connection Route Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRouteResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRouteResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRouteResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionRouteResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnGatewayRequest"> <summary> Deletes a VPN gateway. </summary> <remarks> Use this when you want to delete a VPC and all its associated components because you no longer need them. We recommend that before you delete a VPN gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the VPN gateway if you just want to delete and re-create the VPN connection between your VPC and data center. AWS might delete any VPN gateway if you leave it inactive for an extended period of time (inactive means that there's no VPN connection in use with the VPN gateway). </remarks> </member> <member name="M:Amazon.EC2.Model.DeleteVpnGatewayRequest.WithVpnGatewayId(System.String)"> <summary> Sets the ID of the VPN gateway you want to delete. </summary> <param name="vpnGatewayId">The ID of the VPN gateway you want to delete.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnGatewayRequest.IsSetVpnGatewayId"> <summary> Checks if VpnGatewayId property is set </summary> <returns>true if VpnGatewayId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpnGatewayRequest.VpnGatewayId"> <summary> The ID of the VPN gateway you want to delete. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnGatewayResponse"> <summary> Delete Vpn Gateway Response </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpnGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeleteVpnGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeleteVpnGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DeregisterImageRequest"> <summary> Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. </summary> <remarks> This command does not delete the AMI from Amazon S3. </remarks> </member> <member name="M:Amazon.EC2.Model.DeregisterImageRequest.WithImageId(System.String)"> <summary> Sets the unique ID of the AMI to deregister. </summary> <param name="imageId">Unique ID of the AMI which was assigned during registration.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DeregisterImageRequest.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DeregisterImageRequest.ImageId"> <summary> Unique ID of the AMI which was assigned during registration. </summary> </member> <member name="T:Amazon.EC2.Model.DeregisterImageResponse"> <summary> Deregister Image Response </summary> </member> <member name="M:Amazon.EC2.Model.DeregisterImageResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DeregisterImageResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DeregisterImageResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DeregisterImageResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAccountAttributesRequest"> <summary> Gives you information about the attributes of the account. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesRequest.WithAccountAttributeNames(Amazon.EC2.Model.AccountAttributeName[])"> <summary> Sets account attribute names. </summary> <param name="list">Account attribute names.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesRequest.IsSetAccountAttributeNames"> <summary> Checks if AccountAttributeNames property is set </summary> <returns>true if AccountAttributeNames property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filters used to match system-defined properties and user-defined tags associated with the specified Attributes. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Attributes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesRequest.AccountAttributeNames"> <summary> One or more account attribute names. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified Attributes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAccountAttributesResponse"> <summary> Describe Vpc Attributes Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesResponse.IsSetDescribeAccountAttributesResult"> <summary> Checks if DescribeAccountAttributesResult property is set </summary> <returns>true if DescribeAccountAttributesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesResponse.DescribeAccountAttributesResult"> <summary> Gets and sets the DescribeAccountAttributesResult property. Describe Account Attributes Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAccountAttributesResult"> <summary> Describe Account Attributes Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesResult.IsSetAccountAttributes"> <summary> Checks if AccountAttributes property is set </summary> <returns>true if AccountAttributes property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAccountAttributesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesResult.AccountAttributes"> <summary> Gets and sets the AccountAttributes property. The list of AccountAttributes. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAddressesRequest"> <summary> Lists elastic IP addresses assigned to your account or provides information about a specific address. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesRequest.WithPublicIp(System.String[])"> <summary> Sets the elastic IP address to describe. </summary> <param name="list">Elastic IP address to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesRequest.IsSetPublicIp"> <summary> Checks if PublicIp property is set </summary> <returns>true if PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesRequest.WithAllocationId(System.String[])"> <summary> Sets allocation IDs corresponding to the address or addresses to describe. Applies only to VPC addresses. </summary> <param name="list">One or more allocation IDs corresponding to the address or addresses to describe. Applies only to VPC addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesRequest.IsSetAllocationId"> <summary> Checks if AllocationId property is set </summary> <returns>true if AllocationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the list of filters used to match system-defined properties and user-defined tags associated with the specified DescribeAddresses. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified DescribeAddresses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesRequest.PublicIp"> <summary> Elastic IP address to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesRequest.AllocationId"> <summary> One or more allocation IDs corresponding to the address or addresses to describe. Applies only to VPC addresses. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified DescribeAddresses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAddressesResponse"> <summary> Describe Addresses Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesResponse.IsSetDescribeAddressesResult"> <summary> Checks if DescribeAddressesResult property is set </summary> <returns>true if DescribeAddressesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesResponse.DescribeAddressesResult"> <summary> Gets and sets the DescribeAddressesResult property. Describe Addresses Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAddressesResult"> <summary> Describe Addresses Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesResult.IsSetAddress"> <summary> Checks if Address property is set </summary> <returns>true if Address property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAddressesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesResult.Address"> <summary> Gets and sets the Address property. The list of IP addresses. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAvailabilityZonesRequest"> <summary> Lists Availability Zones that are currently available to the account and their states. </summary> <remarks> Availability Zones are not the same across accounts. The Availability Zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Zone assignments are mapped independently for each account. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.WithZoneName(System.String[])"> <summary> Sets Availability Zone names. </summary> <param name="list">Availability Zone name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.IsSetZoneName"> <summary> Checks if ZoneName property is set </summary> <returns>true if ZoneName property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filters used to match system-defined properties and user-defined tags associated with the specified AvailabilityZones. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified AvailabilityZones. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.ZoneName"> <summary> One or more Availability Zone names. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified AvailabilityZones. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAvailabilityZonesResponse"> <summary> Describe Availability Zones Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesResponse.IsSetDescribeAvailabilityZonesResult"> <summary> Checks if DescribeAvailabilityZonesResult property is set </summary> <returns>true if DescribeAvailabilityZonesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesResponse.DescribeAvailabilityZonesResult"> <summary> Gets and sets the DescribeAvailabilityZonesResult property. Describe Availability Zones Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAvailabilityZonesResult"> <summary> Describe Availability Zones Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesResult.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeAvailabilityZonesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesResult.AvailabilityZone"> <summary> Gets and sets the AvailabilityZone property. Availability Zone information. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeBundleTasksRequest"> <summary> Describes current bundling tasks. </summary> <remarks> Describes in-progress and recent bundle tasks. Complete and failed tasks are removed from the list a short time after completion. If no bundle ids are given, all bundle tasks are returned. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksRequest.WithBundleId(System.String[])"> <summary> Sets the IDs of the bundle tasks to describe. </summary> <param name="list">The ID of the bundle task to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksRequest.IsSetBundleId"> <summary> Checks if BundleId property is set </summary> <returns>true if BundleId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filters used to match system-defined properties and user-defined tags associated with the specified BundleTasks. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified BundleTasks. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksRequest.BundleId"> <summary> One or more IDs of the bundle tasks to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified BundleTasks. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeBundleTasksResponse"> <summary> Describe Bundle Tasks Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksResponse.IsSetDescribeBundleTasksResult"> <summary> Checks if DescribeBundleTasksResult property is set </summary> <returns>true if DescribeBundleTasksResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksResponse.DescribeBundleTasksResult"> <summary> Gets and sets the DescribeBundleTasksResult property. Describe Bundle Tasks Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeBundleTasksResult"> <summary> Describe Bundle Tasks Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksResult.IsSetBundleTask"> <summary> Checks if BundleTask property is set </summary> <returns>true if BundleTask property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeBundleTasksResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksResult.BundleTask"> <summary> Gets and sets the BundleTask property. Bundle Task </summary> </member> <member name="T:Amazon.EC2.Model.DescribeConversionTasksRequest"> <summary> Describes your conversion tasks. For more information, go to Importing Your Virtual Machines and Volumes into Amazon EC2 in the Amazon Elastic Compute Cloud User Guide. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksRequest.WithConversionTaskId(System.String[])"> <summary> Sets conversion task IDs. </summary> <param name="list">A list of conversion tasks.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksRequest.IsSetConversionTaskId"> <summary> Checks if ConversionTaskId property is set </summary> <returns>true if ConversionTaskId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksRequest.ConversionTaskId"> <summary> One or more conversion task IDs. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeConversionTasksResponse"> <summary> The Response for the DescribeConversionTasks operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksResponse.IsSetDescribeConversionTasksResult"> <summary> Checks if DescribeConversionTasksResult property is set </summary> <returns>true if DescribeConversionTasksResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksResponse.DescribeConversionTasksResult"> <summary> Gets and sets the DescribeConversionTasksResult property. DescribeConversionTasks Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeConversionTasksResult"> <summary> DescribeConversionTasks Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksResult.IsSetConversionTasks"> <summary> Checks if ConversionTasks property is set </summary> <returns>true if ConversionTasks property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeConversionTasksResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksResult.ConversionTasks"> <summary> Gets and sets the ConversionTasks property. A list of conversion tasks. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeCustomerGatewaysRequest"> <summary> Returns information about your customer gateways. </summary> <remarks> You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could ask to get information about a particular customer gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the customer gateway has a particular IP address for the Internet-routable external interface, and the gateway's state is pending or available). The result includes information for a particular customer gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.WithCustomerGatewayId(System.String[])"> <summary> Sets customer gateway IDs. </summary> <param name="list">A customer gateway ID. You can specify more than one in the request</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.IsSetCustomerGatewayId"> <summary> Checks if CustomerGatewayId property is set </summary> <returns>true if CustomerGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filter to apply on the results of DescribeCustomerGateways. </summary> <param name="list">The filter to apply on the results of DescribeCustomerGateways. Filters can be: a. state - The state of the Customer Gateway. (pending, available, deleting, deleted). b. type - The type of Customer Gateway. Currently the only supported type is ipsec.1. c. ipAddress - The IP address of the customer gateway's Internet-routable external interface (e.g., 12.1.2.3).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.CustomerGatewayId"> <summary> One ore more customer gateway IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.Filter"> <summary> The filter to apply on the results of DescribeCustomerGateways. </summary> <remarks> Filters can be: a. state - The state of the Customer Gateway. (pending, available, deleting, deleted). b. type - The type of Customer Gateway. Currently the only supported type is ipsec.1. c. ipAddress - The IP address of the customer gateway's Internet-routable external interface (e.g., 12.1.2.3). </remarks> </member> <member name="T:Amazon.EC2.Model.DescribeCustomerGatewaysResponse"> <summary> Describe Customer Gateways Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysResponse.IsSetDescribeCustomerGatewaysResult"> <summary> Checks if DescribeCustomerGatewaysResult property is set </summary> <returns>true if DescribeCustomerGatewaysResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysResponse.DescribeCustomerGatewaysResult"> <summary> Gets and sets the DescribeCustomerGatewaysResult property. Describe Customer Gateways Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeCustomerGatewaysResult"> <summary> Describe Customer Gateways Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysResult.IsSetCustomerGateway"> <summary> Checks if CustomerGateway property is set </summary> <returns>true if CustomerGateway property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeCustomerGatewaysResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysResult.CustomerGateway"> <summary> Gets and sets the CustomerGateway property. List of customer gateways </summary> </member> <member name="T:Amazon.EC2.Model.DescribeDhcpOptionsRequest"> <summary> Gives you information about one or more sets of DHCP options. You can specify one or more DHCP options set IDs, or no IDs (to describe all your sets of DHCP options). </summary> <remarks> The returned information consists of: 1. The DHCP options set ID 2. The options </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsRequest.WithDhcpOptionsId(System.String[])"> <summary> Sets DHCP options set IDs. </summary> <param name="list">A DHCP options set ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsRequest.IsSetDhcpOptionsId"> <summary> Checks if DhcpOptionsId property is set </summary> <returns>true if DhcpOptionsId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified DhcpOptions. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified DhcpOptions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsRequest.DhcpOptionsId"> <summary> One or more DHCP options set IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified DhcpOptions. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeDhcpOptionsResponse"> <summary> Describe Dhcp Options Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsResponse.IsSetDescribeDhcpOptionsResult"> <summary> Checks if DescribeDhcpOptionsResult property is set </summary> <returns>true if DescribeDhcpOptionsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsResponse.DescribeDhcpOptionsResult"> <summary> Gets and sets the DescribeDhcpOptionsResult property. Describe Dhcp Options Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeDhcpOptionsResult"> <summary> Describe Dhcp Options Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsResult.IsSetDhcpOptions"> <summary> Checks if DhcpOptions property is set </summary> <returns>true if DhcpOptions property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeDhcpOptionsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsResult.DhcpOptions"> <summary> Gets and sets the DhcpOptions property. List of DHCP options </summary> </member> <member name="T:Amazon.EC2.Model.DescribeExportTasksRequest"> <summary> Describes your export tasks. If no export task IDs are specified, all export tasks initiated by you are returned. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeExportTasksRequest.WithExportTaskIds(System.String[])"> <summary> Sets export task IDs. </summary> <param name="list">Collection of export task ids to describe</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeExportTasksRequest.IsSetExportTaskIds"> <summary> Checks if the ExportTaskIds property is set. </summary> <returns>True if the ExportTaskIds property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeExportTasksRequest.ExportTaskIds"> <summary> One or more export task IDs. If no task IDs are provided, all active export tasks will be described. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeExportTasksResponse"> <summary> DescribeExportTasksResponse </summary> </member> <member name="M:Amazon.EC2.Model.DescribeExportTasksResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeExportTasksResponse.IsSetDescribeExportTasksResult"> <summary> Checks if DescribeExportTasksResult property is set </summary> <returns>true if DescribeExportTasksResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeExportTasksResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeExportTasksResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeExportTasksResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeExportTasksResponse.DescribeExportTasksResult"> <summary> Gets and sets the DescribeExportTasksResult property. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeExportTasksResult"> <summary> </summary> </member> <member name="M:Amazon.EC2.Model.DescribeExportTasksResult.IsSetExportTasks"> <summary> Checks if the ExportTasks property is set. </summary> <returns>True if the ExportTasks property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeExportTasksResult.ExportTasks"> <summary> Gets and sets the details of the created ExportVM tasks. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImageAttributeRequest"> <summary> Gets information about an attribute of an AMI. Only one attribute can be specified per call. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeRequest.WithImageId(System.String)"> <summary> Sets the ID of the AMI for which an attribute will be described. </summary> <param name="imageId">The ID of the AMI for which an attribute will be described.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeRequest.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeRequest.WithAttribute(System.String)"> <summary> Sets the attribute name to be described. </summary> <param name="attribute"> <para> Attribute name to be described. </para> <para> Valid values: description | kernel | ramdisk | launchPermission | productCodes | blockDeviceMapping </para> </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeRequest.ImageId"> <summary> The ID of the AMI for which an attribute will be described. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeRequest.Attribute"> <summary> Attribute name to be described. </summary> <remarks> Valid values: description | kernel | ramdisk | launchPermission | productCodes | blockDeviceMapping </remarks> </member> <member name="T:Amazon.EC2.Model.DescribeImageAttributeResponse"> <summary> Describe Image Attribute Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeResponse.IsSetDescribeImageAttributeResult"> <summary> Checks if DescribeImageAttributeResult property is set </summary> <returns>true if DescribeImageAttributeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeResponse.DescribeImageAttributeResult"> <summary> Gets and sets the DescribeImageAttributeResult property. Describe Image Attribute Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImageAttributeResult"> <summary> Describe Image Attribute Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeResult.IsSetImageAttribute"> <summary> Checks if ImageAttribute property is set </summary> <returns>true if ImageAttribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeResult.ImageAttribute"> <summary> Gets and sets the ImageAttribute property. Image Attribute </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImagesRequest"> <summary> Returns information about AMIs, AKIs, and ARIs. This includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to you include public images, private images that you own, and private images owned by other users for which you have explicit launch permissions. </summary> <remarks> Launch permissions fall into three categories: 1. public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs. 2. explicit: The owner of the AMI granted launch permissions to a specific user. 3. implicit: A user has implicit launch permissions for all AMIs he or she owns. The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions. If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results. If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own. If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.WithImageId(System.String[])"> <summary> Sets AMI IDs to describe. </summary> <param name="list">AMI IDs to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.WithOwner(System.String[])"> <summary> Sets owner(s) for the AMIs to return. </summary> <param name="list">Returns AMIs owned by the specified owner. Multiple owners can be specified.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.IsSetOwner"> <summary> Checks if Owner property is set </summary> <returns>true if Owner property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.WithExecutableBy(System.String[])"> <summary> Sets executor user IDs. </summary> <param name="list">Returns AMIs for which the specified user has explicit launch permissions.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.IsSetExecutableBy"> <summary> Checks if ExecutableBy property is set </summary> <returns>true if ExecutableBy property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified Images. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.ImageId"> <summary> AMI IDs to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.Owner"> <summary> Owner(s) for the AMIs to return. Multiple owners can be specified. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.ExecutableBy"> <summary> List of executor user IDs. AMIs will be returned for which the specified user(s) have explicit launch permissions. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.Filter"> <summary> One or more filters. <ul> <li> <c>architecture</c> - The image architecture (<c>i386</c> | <c>x86_64</c>). </li> <li> <c>block-device-mapping.delete-on-termination</c> - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. </li> <li> <c>block-device-mapping.device-name</c> - The device name for the Amazon EBS volume (for example, <c>/dev/sdh</c>). </li> <li> <c>block-device-mapping.snapshot-id</c> - The ID of the snapshot used for the Amazon EBS volume. </li> <li> <c>block-device-mapping.volume-size</c> - The volume size of the Amazon EBS volume, in GiB. </li> <li> <c>block-device-mapping.volume-type</c> - The volume type of the Amazon EBS volume (<c>gp2</c> | <c>standard</c> | <c>io1</c>). </li> <li> <c>description</c> - The description of the image (provided during image creation). </li> <li> <c>hypervisor</c> - The hypervisor type (<c>ovm</c> | <c>xen</c>). </li> <li> <c>image-id</c> - The ID of the image. </li> <li> <c>image-type</c> - The image type (<c>machine</c> | <c>kernel</c> | <c>ramdisk</c>). </li> <li> <c>is-public</c> - A Boolean that indicates whether the image is public. </li> <li> <c>kernel-id</c> - The kernel ID. </li> <li> <c>manifest-location</c> - The location of the image manifest. </li> <li> <c>name</c> - The name of the AMI (provided during image creation). </li> <li> <c>owner-alias</c> - The AWS account alias (for example, <c>amazon</c>). </li> <li> <c>owner-id</c> - The AWS account ID of the image owner. </li> <li> <c>platform</c> - The platform. To only list Windows-based AMIs, use <c>windows</c>. </li> <li> <c>product-code</c> - The product code. </li> <li> <c>product-code.type</c> - The type of the product code (<c>devpay</c> | <c>marketplace</c>). </li> <li> <c>ramdisk-id</c> - The RAM disk ID. </li> <li> <c>root-device-name</c> - The name of the root device volume (for example, <c>/dev/sda1</c>). </li> <li> <c>root-device-type</c> - The type of the root device volume (<c>ebs</c> | <c>instance-store</c>). </li> <li> <c>state</c> - The state of the image (<c>available</c> | <c>pending</c> | <c>failed</c>). </li> <li> <c>state-reason-code</c> - The reason code for the state change. </li> <li> <c>state-reason-message</c> - The message for the state change. </li> <li> <c>tag</c>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </li> <li> <c>tag-key</c> - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <c>tag</c>:<i>key</i>=<i>value</i> filter. </li> <li> <c>tag-value</c> - The value of a tag assigned to the resource. This filter is independent of the <c>tag-key</c> filter. </li> <li> <c>virtualization-type</c> - The virtualization type (<c>paravirtual</c> | <c>hvm</c>). </li> </ul> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImagesResponse"> <summary> Describe Images Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeImagesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesResponse.IsSetDescribeImagesResult"> <summary> Checks if DescribeImagesResult property is set </summary> <returns>true if DescribeImagesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeImagesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesResponse.DescribeImagesResult"> <summary> Gets and sets the DescribeImagesResult property. Describe Images Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImagesResult"> <summary> Describe Images Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeImagesResult.IsSetImage"> <summary> Checks if Image property is set </summary> <returns>true if Image property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeImagesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeImagesResult.Image"> <summary> Gets and sets the Image property. List of AMIs </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceAttributeRequest"> <summary> Gets information about an attribute of an instance. Only one attribute can be specified per call. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeRequest.WithInstanceId(System.String)"> <summary> Sets the instance ID to describe. </summary> <param name="instanceId">Instance IDs to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeRequest.WithAttribute(System.String)"> <summary> Sets the attribute to return. </summary> <param name="attribute">Specifies the attribute to return. Values are "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "sourceDestCheck", "groupSet", "rootDeviceName", "blockDeviceMapping", "productCodes" and "ebsOptimized"</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeRequest.InstanceId"> <summary> Instance ID to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeRequest.Attribute"> <summary> The attribute to return. </summary> <remarks> Valid values are "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "sourceDestCheck", "groupSet", "rootDeviceName", "blockDeviceMapping", "productCodes" and "ebsOptimized" </remarks> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceAttributeResponse"> <summary> Information returned by a DescribeInstanceAttribute request. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeResponse.IsSetDescribeInstanceAttributeResult"> <summary> Checks if DescribeInstanceAttributeResult property is set </summary> <returns>true if DescribeInstanceAttributeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeResponse.DescribeInstanceAttributeResult"> <summary> Gets and sets the DescribeInstanceAttributeResult property. Information about the instance attribute. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceAttributeResult"> <summary> Information about the instance attribute. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeResult.IsSetInstanceAttribute"> <summary> Checks if InstanceAttribute property is set </summary> <returns>true if InstanceAttribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeResult.InstanceAttribute"> <summary> Gets and sets the InstanceAttribute property. List of instance attributes. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstancesRequest"> <summary> Returns information about instances that you own. </summary> <remarks> 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 invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results. Recently terminated instances might appear in the returned results.This interval is usually less than one hour. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesRequest.WithInstanceId(System.String[])"> <summary> Sets the instance IDs to describe. </summary> <param name="list">Instance IDs to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filters used to match system-defined properties and user-defined tags associated with the specified Instances. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesRequest.InstanceId"> <summary> Instance IDs to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstancesResponse"> <summary> Describe Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesResponse.IsSetDescribeInstancesResult"> <summary> Checks if DescribeInstancesResult property is set </summary> <returns>true if DescribeInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesResponse.DescribeInstancesResult"> <summary> Gets and sets the DescribeInstancesResult property. Describe Instances Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstancesResult"> <summary> Describe Instances Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesResult.IsSetReservation"> <summary> Checks if Reservation property is set </summary> <returns>true if Reservation property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesResult.Reservation"> <summary> Gets and sets the Reservation property. List of reservations </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceStatusRequest"> <summary> Container for the parameters to the DescribeInstanceStatus operation. <para>Describes the status of one or more instances, including any scheduled events.</para> <para>Instance status has two main components:</para> <ul> <li> <para>System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.</para> </li> <li> <para>Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.</para> </li> </ul> <para>Instance status provides information about four types of scheduled events for an instance that may require your attention:</para> <ul> <li> <para>Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: <c>system-reboot</c> or <c>instance-reboot</c> . System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.</para> </li> <li> <para>System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code <c>system-maintenance</c> . System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.</para> </li> <li> <para>Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code <c>instance-retirement</c> . Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.</para> </li> <li> <para>Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called <c>instance-stop</c> . Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.</para> </li> </ul> <para>When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is <c>instance-retirement</c> . This ensures that your instance is started on a different underlying host.</para> <para>For more information about failed status checks, see <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> . For more information about working with scheduled events, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#schedevents_actions" >Working with an Instance That Has a Scheduled Event</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.WithInstanceId(System.String[])"> <summary> Sets instance IDs. </summary> <param name="list">Instance IDs to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified Instances. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.WithNextToken(System.String)"> <summary> Sets the token specifying the next paginated set of results to return. </summary> <param name="nextToken"></param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.IsSetNextToken"> <summary> Checks if the NextToken property is set. </summary> <returns>true if NextToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.WithMaxResults(System.Int32)"> <summary> Sets the maximum number of paginated instance items per response. </summary> <param name="maxResults">Maximum number of paginated instance items</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.IsSetMaxResults"> <summary> Checks if the MaxResults property is set. </summary> <returns>true if MaxResults property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.WithIncludeAllInstances(System.Boolean)"> <summary> Sets whether the request includes all or only running instances. </summary> <param name="includeAllInstances"> Set true to return the health status for all instances (e.g., running, stopped, pending, shutting down, etc.). Set false to return only the health status for running instances. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusRequest.IsSetIncludeAllInstances"> <summary> Checks if the IncludeAllInstances property is set. </summary> <returns>True if the IncludeAllInstances property is set.</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.InstanceId"> <summary> List of instance IDs. If not specified, all instances are described. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified Instances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.NextToken"> <summary> Token specifying the next paginated set of results to return. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.MaxResults"> <summary> The maximum number of paginated instance items per response. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.IncludeAllInstances"> <summary> Gets and sets whether the request includes all or only running instances. When true, returns the health status for all instances (e.g., running, stopped, pending, shutting down, etc.). When false (default), returns only the health status for running instances. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceStatusResponse"> <summary> Describe Instance Status response. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResponse.IsSetDescribeInstanceStatusResult"> <summary> Checks if DescribeInstanceStatusResult property is set </summary> <returns>true if DescribeInstanceStatusResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusResponse.DescribeInstanceStatusResult"> <summary> Gets and sets the DescribeInstanceStatusResult property. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceStatusResult"> <summary> Describe Instance Status result. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResult.IsSetInstanceStatus"> <summary> Checks if the InstanceStatus property is set </summary> <returns>true if the InstanceStatus property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResult.IsSetNextToken"> <summary> Checks if the NextToken property is set </summary> <returns>true if the NextToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceStatusResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusResult.InstanceStatus"> <summary> Information about the instance status. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusResult.NextToken"> <summary> Gets and sets the NextToken property. A string specifying the next paginated set of results to return. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInternetGatewaysRequest"> <summary> Gives you information about your Internet gateways. </summary> <remarks> You can filter the results to return information only about Internet gateways that match criteria you specify. For example, you could get information only about gateways with particular tags. The Internet gateway must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged with a particular value). The result includes information for a particular Internet gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysRequest.WithInternetGatewayId(System.String[])"> <summary> Sets IDs of the Internet gateways. </summary> <param name="list">IDs of the Internet gateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysRequest.IsSetInternetGatewayId"> <summary> Checks if InternetGatewayId property is set </summary> <returns>true if InternetGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties associated with the specified Tags. </summary> <param name="list">A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysRequest.InternetGatewayId"> <summary> IDs of the Internet gateways. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysRequest.Filter"> <summary> A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInternetGatewaysResponse"> <summary> The Response for the DescribeInternetGateways operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysResponse.IsSetDescribeInternetGatewaysResult"> <summary> Checks if DescribeInternetGatewaysResult property is set </summary> <returns>true if DescribeInternetGatewaysResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysResponse.DescribeInternetGatewaysResult"> <summary> Gets and sets the DescribeInternetGatewaysResult property. DescribeInternetGateways Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInternetGatewaysResult"> <summary> DescribeInternetGateways Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysResult.IsSetInternetGateways"> <summary> Checks if InternetGateways property is set </summary> <returns>true if InternetGateways property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeInternetGatewaysResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysResult.InternetGateways"> <summary> Gets and sets the InternetGateways property. A list of Internet Gateways. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeKeyPairsRequest"> <summary> Returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsRequest.WithKeyName(System.String[])"> <summary> Sets names of key pairs to describe. </summary> <param name="list">Key pair to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsRequest.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified KeyPairs. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsRequest.KeyName"> <summary> Names of key pairs to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified KeyPairs. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeKeyPairsResponse"> <summary> DescribeKeyPairsResponse </summary> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsResponse.IsSetDescribeKeyPairsResult"> <summary> Checks if DescribeKeyPairsResult property is set </summary> <returns>true if DescribeKeyPairsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsResponse.DescribeKeyPairsResult"> <summary> Gets and sets the DescribeKeyPairsResult property. Describe Key Pairs Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeKeyPairsResult"> <summary> Describe Key Pairs Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsResult.IsSetKeyPair"> <summary> Checks if KeyPair property is set </summary> <returns>true if KeyPair property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeKeyPairsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsResult.KeyPair"> <summary> Gets and sets the KeyPair property. List of key pairs </summary> </member> <member name="T:Amazon.EC2.Model.DescribeLicensesRequest"> <summary> Provides details of a user's registered licenses. </summary> <remarks> Zero or more IDs may be specified on the call. When one or more license IDs are specified, only data for the specified IDs are returned. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesRequest.WithLicenseId(System.String[])"> <summary> Sets the licenses for which details are to be returned. </summary> <param name="list">Specifies the license registration for which details are to be returned.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesRequest.IsSetLicenseId"> <summary> Checks if LicenseId property is set </summary> <returns>true if LicenseId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified Licenses. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Licenses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeLicensesRequest.LicenseId"> <summary> Licenses for which details are to be returned. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeLicensesRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified Licenses. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesResponse.IsSetDescribeLicensesResult"> <summary> Checks if DescribeLicensesResult property is set </summary> <returns>true if DescribeLicensesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeLicensesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeLicensesResponse.DescribeLicensesResult"> <summary> Gets and sets the DescribeLicensesResult property. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesResult.IsSetLicense"> <summary> Checks if License property is set </summary> <returns>true if License property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeLicensesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeLicensesResult.License"> <summary> Gets and sets the License property. Specifies active licenses in use and attached to an Amazon EC2 instance. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkAclsRequest"> <summary> Gives you information about the network ACLs in your VPC. </summary> <remarks> You can filter the results to return information only about ACLs that match criteria you specify. For example, you could get information for only the ACL associated with a particular subnet. The ACL must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an egress entry that denies traffic to a particular port). The result includes information for a particular ACL only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character.You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsRequest.WithNetworkAclId(System.String[])"> <summary> Sets the IDs of the route tables. </summary> <param name="list">IDs of the route tables.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsRequest.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filters used to match system-defined properties associated with the specified Tags. </summary> <param name="list">A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsRequest.NetworkAclId"> <summary> IDs of the route tables. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsRequest.Filter"> <summary> A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkAclsResponse"> <summary> The Response for the DescribeNetworkAcls operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsResponse.IsSetDescribeNetworkAclsResult"> <summary> Checks if DescribeNetworkAclsResult property is set </summary> <returns>true if DescribeNetworkAclsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsResponse.DescribeNetworkAclsResult"> <summary> Gets and sets the DescribeNetworkAclsResult property. DescribeNetworkAcls Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkAclsResult"> <summary> DescribeNetworkAcls Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsResult.IsSetNetworkAcls"> <summary> Checks if NetworkAcls property is set </summary> <returns>true if NetworkAcls property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkAclsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsResult.NetworkAcls"> <summary> Gets and sets the NetworkAcls property. A list of NetworkAcls. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest"> <summary> Describes a Network Interface Attribute. Only one attribute can be specified per call. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface. </summary> <param name="networkInterfaceId">The ID of the network interface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.IsSetNetworkInterfaceId"> <summary> Checks if NetworkInterfaceId property is set </summary> <returns>true if NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.WithAttribute(System.String)"> <summary> Sets the name of the attribute to describe. </summary> <param name="attribute">Name of the attribute to describe. Values are "description", "sourceDestCheck" and "groupSet" and "attachment". </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.NetworkInterfaceId"> <summary> The ID of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.Attribute"> <summary> Name of the attribute to describe. Values are "description", "sourceDestCheck" and "groupSet" and "attachment". </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse"> <summary> Describe Network Interface Attribute response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse.IsSetDescribeNetworkInterfaceAttributeResult"> <summary> Checks if DescribeNetworkInterfaceAttributeResult property is set </summary> <returns>true if DescribeNetworkInterfaceAttributeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse.DescribeNetworkInterfaceAttributeResult"> <summary> Gets and sets the DescribeNetworkInterfaceAttributeResult property. Information about the interface attribute. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult"> <summary> Describe Network Interface Attribute result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.IsSetNetworkInterfaceAttribute"> <summary> Checks if NetworkInterfaceAttribute property is set </summary> <returns>true if NetworkInterfaceAttribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.NetworkInterfaceAttribute"> <summary> Gets and sets the NetworkInterfaceAttribute property. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfacesRequest"> <summary> Describes one or more Network Interfaces. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.WithNetworkInterfaceId(System.String[])"> <summary> Sets the network interface IDs. </summary> <param name="list">Network Interface Ids to describe</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.IsSetNetworkInterfaceId"> <summary> Checks if NetworkInterfaceId property is set </summary> <returns>true if NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties associated with the specified network interfaces. </summary> <param name="list">A list of filters. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.NetworkInterfaceId"> <summary> One or more network interface IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.Filter"> <summary> A list of filters used to match system-defined properties associated with the specified network interfaces. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfacesResponse"> <summary> Describe Network Interfaces response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesResponse.IsSetDescribeNetworkInterfacesResult"> <summary> Checks if DescribeNetworkInterfacesResult property is set </summary> <returns>true if DescribeNetworkInterfacesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesResponse.DescribeNetworkInterfaceResult"> <summary> Gets and sets the DescribeNetworkInterfacesResult property. Information about the network interfaces. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfacesResult"> <summary> Describe Network Interfaces result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesResult.IsSetNetworkInterface"> <summary> Checks if the NetworkInterface property is set </summary> <returns>true if the NetworkInterface property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeNetworkInterfacesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesResult.NetworkInterface"> <summary> Gets and sets the NetworkInterface property </summary> </member> <member name="T:Amazon.EC2.Model.DescribePlacementGroupsRequest"> <summary> Returns information about one or more PlacementGroup instances in a user's account. </summary> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsRequest.WithGroupName(System.String[])"> <summary> Sets the name of the PlacementGroup. </summary> <param name="list">The name of the PlacementGroup.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified PlacementGroups. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified PlacementGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsRequest.GroupName"> <summary> The name of the PlacementGroup. </summary> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified PlacementGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribePlacementGroupsResponse"> <summary> Information returned by the DescribePlacementGroup request. </summary> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsResponse.IsSetDescribePlacementGroupsResult"> <summary> Checks if DescribePlacementGroupsResult property is set </summary> <returns>true if DescribePlacementGroupsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsResponse.DescribePlacementGroupsResult"> <summary> Gets and sets the DescribePlacementGroupsResult property. </summary> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsResult.IsSetPlacementGroupInfo"> <summary> Checks if PlacementGroupInfo property is set </summary> <returns>true if PlacementGroupInfo property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribePlacementGroupsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsResult.PlacementGroupInfo"> <summary> Gets and sets the PlacementGroupInfo property. Contains information about the specified PlacementGroups. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRegionsRequest"> <summary> Describes regions that are currently available to the account. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsRequest.WithRegionName(System.String[])"> <summary> Sets names of regions to describe. </summary> <param name="list">Name of a region.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsRequest.IsSetRegionName"> <summary> Checks if RegionName property is set </summary> <returns>true if RegionName property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified Region. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Region. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsRequest.RegionName"> <summary> One of more names of regions to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified Region. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRegionsResponse"> <summary> Describe Regions Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsResponse.IsSetDescribeRegionsResult"> <summary> Checks if DescribeRegionsResult property is set </summary> <returns>true if DescribeRegionsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsResponse.DescribeRegionsResult"> <summary> Gets and sets the DescribeRegionsResult property. Describe Regions Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRegionsResult"> <summary> Describe Regions Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsResult.IsSetRegion"> <summary> Checks if Region property is set </summary> <returns>true if Region property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRegionsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsResult.Region"> <summary> Gets and sets the Region property. List of regions </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.WithReservedInstancesListingId(System.String[])"> <summary> Sets the Ids of the Reserved Instance Listings to describe. </summary> <param name="list">Reserved Instance Listing Ids</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.IsSetReservedInstancesListingId"> <summary> Checks if the ReservedInstancesListingId property is set </summary> <returns>true if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.WithReservedInstancesId(System.String[])"> <summary> Sets the IDs of the Reserved Instances to describe. </summary> <param name="list">IDs of the Reserved Instances to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.IsSetReservedInstancesId"> <summary> Checks if ReservedInstancesId property is set </summary> <returns>true if ReservedInstancesId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstancesOfferings. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstancesOfferings. </param> <returns>this instance</returns> <remarks> The filters available for this operation are: * status - The status of the Reserved Instance listing. Valid Values: pending | active | cancelled | closed . * status-message - The reason for the status. * reserved-instances-listing-id - The ID of the Reserved Instance listing. * reserved-instances-id - The ID of the Reserved Instances. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.ReservedInstancesListingId"> <summary> Ids of the Reserved Instance Listings to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.ReservedInstancesId"> <summary> IDs of the Reserved Instances to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstancesOfferings. </summary> <remarks> The filters available for this operation are: * status - The status of the Reserved Instance listing. Valid Values: pending | active | cancelled | closed . * status-message - The reason for the status. * reserved-instances-listing-id - The ID of the Reserved Instance listing. * reserved-instances-id - The ID of the Reserved Instances. </remarks> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse"> <summary> Describe Reserved Instances Listings response from the service </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse.IsSetDescribeReservedInstancesListingResult"> <summary> Checks if DescribeReservedInstancesListingsResult property is set </summary> <returns>true if DescribeReservedInstancesListingsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse.DescribeReservedInstancesListingsResult"> <summary> The Reserved Instance listing information. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesListingsResult"> <summary> Describe Reserved Instances Listings Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsResult.IsSetReservedInstancesListings"> <summary> Checks if the ReservedInstancesListings property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesListingsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsResult.ReservedInstancesListings"> <summary> The Reserved Instances Listings. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest"> <summary> Container for the parameters to the DescribeReservedInstancesModifications operation. <para> The DescribeReservedInstancesModifications operation describes modifications made to Reserved Instances in your account. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest.ReservedInstancesModificationIds"> <summary> An optional list of Reserved Instances modification IDs to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest.NextToken"> <summary> A string specifying the next paginated set of results to return. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest.Filter"> <summary> A list of filters used to match properties for ReservedInstancesModifications. For a complete reference to the available filter keys for this operation, see the <a href="http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/">Amazon EC2 API reference</a>. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse"> <summary> Describe Reserved Instances Modifications Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse.IsSetDescribeReservedInstancesModificationsResult"> <summary> Checks if DescribeReservedInstancesOfferingsResult property is set </summary> <returns>true if DescribeReservedInstancesOfferingsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse.DescribeReservedInstancesModificationsResult"> <summary> Gets and sets the DescribeReservedInstancesOfferingsResult property. Describe Reserved Instances Offerings Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult"> <summary> Describe Reserved Instances Modifications Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult.ReservedInstancesModifications"> <summary> The list of Reserved Instances modification requests. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult.NextToken"> <summary> The string specifying the next paginated set of results to return. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcAttributeRequest"> <summary> Gives you information about the attributes of a VPC. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeRequest.WithVpcId(System.String)"> <summary> Sets the VPC ID to describe. </summary> <param name="vpcId">VPC ID to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeRequest.WithAttribute(System.String)"> <summary> Sets the attribute to return. </summary> <param name="attribute">Specifies the attribute to return. Values are "enableDnsSupport", "enableDnsHostnames""</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeRequest.VpcId"> <summary> VPC ID to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeRequest.Attribute"> <summary> The attribute to return. </summary> <remarks> Valid values are "enableDnsSupport", "enableDnsHostnames" </remarks> </member> <member name="T:Amazon.EC2.Model.DescribeVpcAttributeResponse"> <summary> Describe Vpc Attributes Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResponse.IsSetDescribeVpcAttributeResult"> <summary> Checks if DescribeVpcAttributesResult property is set </summary> <returns>true if DescribeVpcAttributesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResponse.DescribeVpcAttributeResult"> <summary> Gets and sets the DescribeVpcAttributesResult property. Describe Vpc Attributes Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcAttributeResult"> <summary> Describe Vpc Attributes Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResult.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResult.IsSetEnableDnsSupport"> <summary> Checks if EnableDnsSupport property is set </summary> <returns>true if EnableDnsSupport property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResult.IsSetEnableDnsHostnames"> <summary> Checks if EnableDnsHostnames property is set </summary> <returns>true if EnableDnsHostnames property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcAttributeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResult.VpcId"> <summary> Id of the target VPC. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResult.EnableDnsSupport"> <summary> Flag that signals if the EnableDnsSupport attribute is true or false. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResult.EnableDnsHostnames"> <summary> Flag that signals if the EnableDnsHostnames attribute is true or false. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest"> <summary> Container for the parameters to the DescribeVpcPeeringConnections operation. <para>Describes one or more of your VPC peering connections.</para> </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.WithVpcPeeringConnectionIds(System.String[])"> <summary> Sets the VpcPeeringConnectionIds <param name="list">The VpcPeeringConnectionIds.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.IsSetVpcPeeringConnectionIds"> <summary> Checks if VpcPeeringConnectionIds is set </summary> <returns>true if VpcPeeringConnectionIds property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.WithFilters(Amazon.EC2.Model.Filter[])"> <summary> Sets the Filters <param name="list">The Filters.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.IsSetFilters"> <summary> Checks if Filters is set </summary> <returns>true if Filters property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.VpcPeeringConnectionIds"> <summary> One or more VPC peering connection IDs. Default: Describes all your VPC peering connections. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.Filters"> <summary> One or more filters. <ul> <li> <c>accepter-vpc-info.cidr-block</c> - The CIDR block of the peer VPC. </li> <li> <c>accepter-vpc-info.owner-id</c> - The AWS account ID of the owner of the peer VPC. </li> <li> <c>accepter-vpc-info.vpc-id</c> - The ID of the peer VPC. </li> <li> <c>expiration-time</c> - The expiration date and time for the VPC peering connection. </li> <li> <c>requester-vpc-info.cidr-block</c> - The CIDR block of the requester's VPC. </li> <li> <c>requester-vpc-info.owner-id</c> - The AWS account ID of the owner of the requester VPC. </li> <li> <c>requester-vpc-info.vpc-id</c> - The ID of the requester VPC. </li> <li> <c>status-code</c> - The status of the VPC peering connection (<c>pending-acceptance</c> | <c>failed</c> | <c>expired</c> | <c>provisioning</c> | <c>active</c> | <c>deleted</c> | <c>rejected</c>). </li> <li> <c>status-message</c> - A message that provides more information about the status of the VPC peering connection, if applicable. </li> <li> <c>tag</c>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </li> <li> <c>tag-key</c> - The key of a tag assigned to the resource. This filter is independent of the <c>tag-value</c> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <c>tag</c>:<i>key</i>=<i>value</i> filter. </li> <li> <c>tag-value</c> - The value of a tag assigned to the resource. This filter is independent of the <c>tag-key</c> filter. </li> <li> <c>vpc-peering-connection-id</c> - The ID of the VPC peering connection. </li> </ul> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse"> <summary> The Response for the DescribeVpcPeeringConnections operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse.IsSetDescribeVpcPeeringConnectionsResult"> <summary> Checks if DescribeVpcPeeringConnectionsResult property is set </summary> <returns>true if DescribeVpcPeeringConnectionsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse.DescribeVpcPeeringConnectionsResult"> <summary> Gets and sets the DescribeVpcPeeringConnectionsResult property. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResult.WithVpcPeeringConnection(Amazon.EC2.Model.VpcPeeringConnection[])"> <summary> Sets the VpcPeeringConnection <param name="list">The VpcPeeringConnection.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResult.IsSetVpcPeeringConnection"> <summary> Checks if VpcPeeringConnection is set </summary> <returns>true if VpcPeeringConnection property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResult.VpcPeeringConnection"> <summary> Information about the VPC peering connections </summary> </member> <member name="T:Amazon.EC2.Model.DryRunResponse"> <summary> DryRun response </summary> </member> <member name="M:Amazon.EC2.Model.DryRunResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DryRunResponse.IsSetDryRunResult"> <summary> Checks if DryRunResult property is set </summary> <returns>true if GetConsoleOutputResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DryRunResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DryRunResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DryRunResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DryRunResponse.DryRunResult"> <summary> Gets and sets the GetConsoleOutputResult property. Get Console Output Result </summary> </member> <member name="T:Amazon.EC2.Model.DryRunResult"> <summary> DryRun result If the dry-run was successful, the IsSuccessful field will be set to true; otherwise, false. More information may be available on the Message and Error fields. </summary> </member> <member name="M:Amazon.EC2.Model.DryRunResult.IsSetIsSuccessful"> <summary> Checks if IsSuccessful property is set </summary> <returns>true if IsSuccessful property is set</returns> </member> <member name="M:Amazon.EC2.Model.DryRunResult.IsSetMessage"> <summary> Checks if Message property is set </summary> <returns>true if Message property is set</returns> </member> <member name="M:Amazon.EC2.Model.DryRunResult.IsSetError"> <summary> Checks if Error property is set </summary> <returns>true if Error property is set</returns> </member> <member name="M:Amazon.EC2.Model.DryRunResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DryRunResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DryRunResult.IsSuccessful"> <summary> Flag that signals if you have the required permissions to execute the request. </summary> </member> <member name="P:Amazon.EC2.Model.DryRunResult.Message"> <summary> Message associated with the response. </summary> </member> <member name="P:Amazon.EC2.Model.DryRunResult.Error"> <summary> Exception associated with the response, if there was one. </summary> </member> <member name="T: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. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesRequest.ClientToken"> <summary> A unique, case-sensitive, token you provide to ensure idempotency of your modification request. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesRequest.ReservedInstancesIds"> <summary> The IDs of the Reserved Instances to modify. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesRequest.TargetConfigurations"> <summary> The configuration settings for the Reserved Instances to modify. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyReservedInstancesResponse"> <summary> Modify Reserved Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.ModifyReservedInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyReservedInstancesResponse.IsSetMonitorInstancesResult"> <summary> Checks if MonitorInstancesResult property is set </summary> <returns>true if MonitorInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyReservedInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifyReservedInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesResponse.ModifyReservedInstancesResult"> <summary> Gets and sets the MonitorInstancesResult property. Monitor Instances Result </summary> </member> <member name="T:Amazon.EC2.Model.ModifyReservedInstancesResult"> <summary> <para> The result of modifying Reserved Instances. Contains the ID of the modification request. </para> </summary> </member> <member name="M:Amazon.EC2.Model.ModifyReservedInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifyReservedInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesResult.ReservedInstancesModificationId"> <summary> The unique ID for the submitted modification request. </summary> </member> <member name="T:Amazon.EC2.Model.RejectVpcPeeringConnectionRequest"> <summary> Container for the parameters to the RejectVpcPeeringConnection operation. <para>Rejects a VPC peering connection request. The VPC peering connection must be in the <c>pending-acceptance</c> state. Use the <c>DescribeVpcPeeringConnections</c> request to view your outstanding VPC peering connection requests.</para> </summary> </member> <member name="M:Amazon.EC2.Model.RejectVpcPeeringConnectionRequest.WithVpcPeeringConnectionId(System.String)"> <summary> Sets the VpcPeeringConnectionId <param name="vpcPeeringConnectionId">The VpcPeeringConnectionId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RejectVpcPeeringConnectionRequest.IsSetVpcPeeringConnectionId"> <summary> Checks if VpcPeeringConnectionId is set </summary> <returns>true if VpcPeeringConnectionId property is set</returns> </member> <member name="P:Amazon.EC2.Model.RejectVpcPeeringConnectionRequest.VpcPeeringConnectionId"> <summary> The ID of the VPC peering connection. </summary> </member> <member name="T:Amazon.EC2.Model.RejectVpcPeeringConnectionResponse"> <summary> The Response for the RejectVpcPeeringConnection operation. </summary> </member> <member name="M:Amazon.EC2.Model.RejectVpcPeeringConnectionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.RejectVpcPeeringConnectionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RejectVpcPeeringConnectionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RejectVpcPeeringConnectionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesConfiguration"> <summary> <para> The configuration settings for the modified Reserved Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.AvailabilityZone"> <summary> The Availability Zone for the modified Reserved Instances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.Platform"> <summary> The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.InstanceCount"> <summary> The number of modified Reserved Instances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.InstanceType"> <summary> The instance type for the modified Reserved Instances. </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesId"> <summary>Reserved Instances Id </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesModification"> <summary> Information about a specific modification request to your Reserved Instances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ReservedInstancesModificationId"> <summary> The unique ID for the submitted modification request. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ReservedInstancesIds"> <summary> The IDs of the Reserved Instances submitted for modification. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ModificationResults"> <summary> The resulting information about the modified Reserved Instances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.CreateDate"> <summary> The time the modification request was created. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.UpdateDate"> <summary> The time the modification request was last updated. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.EffectiveDate"> <summary> The time the modification becomes effective. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.Status"> <summary> The status of the modification request, which can be any of the following values: processing, fulfilled, failed. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.StatusMessage"> <summary> The reason for the status. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ClientToken"> <summary> The idempotency token for the modification request. </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesModificationResult"> <summary> The resulting information about the modified Reserved Instances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModificationResult.ReservedInstancesId"> <summary> The ID for the Reserved Instances created as part of the modification request. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModificationResult.TargetConfiguration"> <summary> The configuration settings for the modified Reserved Instances. </summary> </member> <member name="T:Amazon.EC2.Model.VpcPeeringConnection"> <summary> <para>Describes a VPC peering connection.</para> </summary> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.WithVpcPeeringConnectionId(System.String)"> <summary> Sets the VpcPeeringConnectionId <param name="vpcPeeringConnectionId">The VpcPeeringConnectionId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.IsSetVpcPeeringConnectionId"> <summary> Checks if VpcPeeringConnectionId is set </summary> <returns>true if VpcPeeringConnectionId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.WithRequesterVpcInfo(Amazon.EC2.Model.VpcPeeringConnectionVpcInfo)"> <summary> Sets the RequesterVpcInfo <param name="requesterVpcInfo">The RequesterVpcInfo.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.IsSetRequesterVpcInfo"> <summary> Checks if RequesterVpcInfo is set </summary> <returns>true if RequesterVpcInfo property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.WithAccepterVpcInfo(Amazon.EC2.Model.VpcPeeringConnectionVpcInfo)"> <summary> Sets the AccepterVpcInfo <param name="accepterVpcInfo">The AccepterVpcInfo.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.IsSetAccepterVpcInfo"> <summary> Checks if AccepterVpcInfo is set </summary> <returns>true if AccepterVpcInfo property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.WithStatus(Amazon.EC2.Model.VpcPeeringConnectionStateReason)"> <summary> Sets the Status <param name="status">The Status.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.IsSetStatus"> <summary> Checks if Status is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.WithExpirationTime(System.DateTime)"> <summary> Sets the ExpirationTime <param name="expirationTime">The ExpirationTime.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.IsSetExpirationTime"> <summary> Checks if ExpirationTime is set </summary> <returns>true if ExpirationTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.WithResourceTags(Amazon.EC2.Model.ResourceTag[])"> <summary> Sets the ResourceTags <param name="list">The ResourceTags.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnection.IsSetResourceTags"> <summary> Checks if ResourceTags is set </summary> <returns>true if ResourceTags property is set</returns> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.VpcPeeringConnectionId"> <summary> The ID of the VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.RequesterVpcInfo"> <summary> The information of the requester VPC. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.AccepterVpcInfo"> <summary> The information of the peer VPC. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.Status"> <summary> The status of the VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.ExpirationTime"> <summary> The time that an unaccepted VPC peering connection will expire. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.ResourceTags"> <summary> Any tags assigned to the resource. </summary> </member> <member name="T:Amazon.EC2.Model.VpcPeeringConnectionStateReason"> <summary> <para>Describes the status of a VPC peering connection.</para> </summary> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionStateReason.WithCode(System.String)"> <summary> Sets the Code <param name="code">The Code.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionStateReason.IsSetCode"> <summary> Checks if Code is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionStateReason.WithMessage(System.String)"> <summary> Sets the Message <param name="message">The Message.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionStateReason.IsSetMessage"> <summary> Checks if Message is set </summary> <returns>true if Message property is set</returns> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionStateReason.Code"> <summary> The status of the VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionStateReason.Message"> <summary> A message that provides more information about the status, if applicable. </summary> </member> <member name="T:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo"> <summary> <para>Describes a VPC in a VPC peering connection.</para> </summary> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.WithOwnerId(System.String)"> <summary> Sets the OwnerId <param name="ownerId">The OwnerId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.IsSetOwnerId"> <summary> Checks if OwnerId is set </summary> <returns>true if OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.WithVpcId(System.String)"> <summary> Sets the VpcId <param name="vpcId">The VpcId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.IsSetVpcId"> <summary> Checks if VpcId is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.WithCidrBlock(System.String)"> <summary> Sets the CidrBlock <param name="cidrBlock">The CidrBlock.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.IsSetCidrBlock"> <summary> Checks if CidrBlock is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.OwnerId"> <summary> The AWS account ID of the VPC owner. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.VpcId"> <summary> The ID of the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.CidrBlock"> <summary> The CIDR block for the VPC. </summary> </member> <member name="T:Amazon.EC2.Util.EC2Metadata"> <summary> EC2 Instance Metadata. </summary> <remarks> <para> Amazon EC2 instances can access instance-specific metadata, as well as data supplied when launching the instances, using a specific URI. </para> <para> You can use this data to build more generic AMIs that can be modified by configuration files supplied at launch time. For example, if you run web servers for various small businesses, they can all use the same AMI and retrieve their content from the Amazon S3 bucket you specify at launch. To add a new customer at any time, simply create a bucket for the customer, add their content, and launch your AMI. </para> <para> More information about EC2 Metadata <see href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html"/> </para> </remarks> </member> <member name="M:Amazon.EC2.Util.EC2Metadata.GetItems(System.String)"> <summary> Return the list of items in the metadata at path. </summary> <param name="path">Path at which to query the metadata</param> <returns>List of items returned by the metadata service</returns> </member> <member name="M:Amazon.EC2.Util.EC2Metadata.GetData(System.String)"> <summary> Return the metadata at the path </summary> <param name="path">Path at which to query the metadata</param> <returns>Data returned by the metadata service</returns> </member> <member name="M:Amazon.EC2.Util.EC2Metadata.GetData(System.String,System.Int32)"> <summary> Return the metadata at the path </summary> <param name="path">Path at which to query the metadata</param> <param name="tries">Number of attempts to make</param> <returns>Data returned by the metadata service</returns> </member> <member name="M:Amazon.EC2.Util.EC2Metadata.GetItems(System.String,System.Int32)"> <summary> Return the list of items in the metadata at path. </summary> <param name="path">Path at which to query the metadata</param> <param name="tries">Number of attempts to make</param> <returns>List of items returned by the metadata service</returns> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.AmiId"> <summary> The AMI ID used to launch the instance. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.AmiLaunchIndex"> <summary> The index of this instance in the reservation. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.AmiManifestPath"> <summary> The manifest path of the AMI with which the instance was launched. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.AncestorAmiIds"> <summary> The AMI IDs of any instances that were rebundled to create this AMI. Will only exist if the AMI manifest file contained an ancestor-amis key. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.Hostname"> <summary> The private hostname of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.InstanceAction"> <summary> Notifies the instance that it should reboot in preparation for bundling. Valid values: none | shutdown | bundle-pending. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.InstanceId"> <summary> The ID of this instance. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.InstanceType"> <summary> The type of instance. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.KernelId"> <summary> The ID of the kernel launched with this instance, if applicable. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.LocalHostname"> <summary> The local hostname of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which device-number is 0). </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.MacAddress"> <summary> The instance's MAC address. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which device-number is 0). </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.PrivateIpAddress"> <summary> The private IP address of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which device-number is 0). </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.AvailabilityZone"> <summary> The Availability Zone in which the instance launched. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.ProductCodes"> <summary> Product codes associated with the instance, if any. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.PublicKey"> <summary> Public key. Only available if supplied at instance launch time. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.RamdiskId"> <summary> The ID of the RAM disk specified at launch time, if applicable. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.ReservationId"> <summary> ID of the reservation. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.SecurityGroups"> <summary> The names of the security groups applied to the instance. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.IAMInstanceProfileInfo"> <summary> Returns information about the last time the instance profile was updated, including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.IAMSecurityCredentials"> <summary> Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM roles on the instance. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.BlockDeviceMapping"> <summary> The virtual devices associated with the ami, root, ebs, and swap. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.NetworkInterfaces"> <summary> The network interfaces on the instance. </summary> </member> <member name="P:Amazon.EC2.Util.EC2Metadata.UserData"> <summary> The metadata sent to the instance. </summary> </member> <member name="T:Amazon.EC2.Util.IAMInfo"> <summary> Returns information about the last time the instance profile was updated, including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId. </summary> </member> <member name="P:Amazon.EC2.Util.IAMInfo.Code"> <summary> The status of the instance profile </summary> </member> <member name="P:Amazon.EC2.Util.IAMInfo.Message"> <summary> Further information about the status of the instance profile </summary> </member> <member name="P:Amazon.EC2.Util.IAMInfo.LastUpdated"> <summary> The date and time the instance profile was updated </summary> </member> <member name="P:Amazon.EC2.Util.IAMInfo.InstanceProfileArn"> <summary> The Amazon Resource Name (ARN) of the instance profile </summary> </member> <member name="P:Amazon.EC2.Util.IAMInfo.InstanceProfileId"> <summary> The Id of the instance profile </summary> </member> <member name="T:Amazon.EC2.Util.IAMSecurityCredential"> <summary> The temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration) associated with the IAM role. </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.Code"> <summary> The status of the security credential </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.Message"> <summary> Further information about the status of the instance profile </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.LastUpdated"> <summary> The date and time the security credential was last updated </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.Type"> <summary> The type of the security credential </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.AccessKeyId"> <summary> The uniqe id of the security credential </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.SecretAccessKey"> <summary> The secret key used to sign requests </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.Token"> <summary> The security token </summary> </member> <member name="P:Amazon.EC2.Util.IAMSecurityCredential.Expiration"> <summary> The date and time when these credentials expire </summary> </member> <member name="T:Amazon.EC2.Util.NetworkInterface"> <summary> All of the metadata associated with a network interface on the instance. </summary> </member> <member name="M:Amazon.EC2.Util.NetworkInterface.GetIpV4Association(System.String)"> <summary> Get the private IPv4 address(es) that are associated with the public-ip address and assigned to that interface. </summary> <param name="publicIp">The public IP address</param> <returns>Private IPv4 address(es) associated with the public IP address</returns> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.MacAddress"> <summary> The interface's Media Access Control (mac) address. </summary> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.OwnerId"> <summary> The ID of the owner of the network interface. </summary> <remarks> In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. Traffic on an interface is always billed to the interface owner. </remarks> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.Profile"> <summary> The interface's profile </summary> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.LocalHostname"> <summary> The interface's local hostname. </summary> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.LocalIPv4s"> <summary> The private IP addresses associated with the interface. </summary> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.PublicHostname"> <summary> The interface's public hostname. </summary> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.PublicIPv4s"> <summary> The elastic IP addresses associated with the interface. </summary> <remarks> There may be multiple IP addresses on an instance. </remarks> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.SecurityGroups"> <summary> Security groups to which the network interface belongs. </summary> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.SecurityGroupIds"> <summary> IDs of the security groups to which the network interface belongs. Returned only for Amazon EC2 instances launched into a VPC. </summary> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.SubnetId"> <summary> The ID of the Amazon EC2-VPC subnet in which the interface resides. </summary> <remarks> Returned only for Amazon EC2 instances launched into a VPC. </remarks> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.SubnetIPv4CidrBlock"> <summary> The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. </summary> <remarks> Returned only for Amazon EC2 instances launched into a VPC. </remarks> </member> <member name="P:Amazon.EC2.Util.NetworkInterface.VpcId"> <summary> The CIDR block of the Amazon EC2-VPC subnet in which the interface resides. </summary> <remarks> Returned only for Amazon EC2 instances launched into a VPC. </remarks> </member> <member name="T:Amazon.EC2.Util.ImageUtilities"> <summary> This class has utility methods for finding common Amazon machine images. </summary> </member> <member name="M:Amazon.EC2.Util.ImageUtilities.ParseAMIDefinitions(System.IO.StreamReader)"> <summary> Parses the ami definition content into the ImageDescriptor members. </summary> <param name="reader">A reader of the ami definitions</param> </member> <member name="M:Amazon.EC2.Util.ImageUtilities.FindImage(Amazon.EC2.AmazonEC2,Amazon.EC2.Util.ImageUtilities.ImageDescriptor)"> <summary> Find the Amazon machine image identified by the ImageDescriptor. </summary> <param name="ec2Client">The EC2 client used to search for the image.</param> <param name="descriptor">The descriptor used to identify the image.</param> <returns>The Amazon machine image.</returns> </member> <member name="T:Amazon.EC2.Util.ImageUtilities.ImageDescriptor"> <summary> This class identifies an image that will be looked up using a logical key independent of release (RTM) or service pack (SPx) designations, always returning the latest version of an image. </summary> </member> <member name="P:Amazon.EC2.Util.ImageUtilities.ImageDescriptor.DefinitionKey"> <summary> The logical name assigned to this image in the backing definitions file. This key is independent of RTM/service pack number. </summary> </member> <member name="P:Amazon.EC2.Util.ImageUtilities.ImageDescriptor.NamePrefix"> <summary> The name prefix or pattern of the Amazon machine image that will be looked up. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchNATInstanceRequest.SubnetId"> <summary> Gets and sets the subnet that the NAT instance will be launched in. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchNATInstanceRequest.InstanceType"> <summary> Gets and sets the instance type of the NAT instance. The default value is "m1.small". </summary> </member> <member name="P:Amazon.EC2.Util.LaunchNATInstanceRequest.KeyName"> <summary> Gets and sets the key name of the NAT instance. </summary> </member> <member name="T:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsRequest"> <summary> The properties used to create a VPC, a public subnet, private subnet and a NAT EC2 instance to allow EC2 instances in the private subnet to establish outbound connections to the internet. </summary> </member> <member name="T:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest"> <summary> The properties used to create a VPC with a subnet that will have an internet gateway attached making instances available to the internet. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest.VPCName"> <summary> Gets and sets a name that will be assigned the VPC's Name tag. This is an optional field. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest.VPCCidrBlock"> <summary> Gets and sets the CIDR block you want the VPC to cover. The default value is "10.0.0.0/16". </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest.InstanceTenancy"> <summary> The supported tenancy of instances launched into the VPC. The default value is "default". </summary> <remarks> A value of "default" means instances can be launched with any tenancy; a value of "dedicated" means all instances launched into the VPC will be launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Setting the instance's tenancy attribute to dedicated specifies that your instance will run on single-tenant hardware. </remarks> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest.PublicSubnetCiderBlock"> <summary> Gets and sets the CIDR block you want the public subnet to cover. The default value is "10.0.0.0/24". </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest.PublicSubnetAvailabilityZone"> <summary> Gets and sets the Availability Zone you want the public subnet in. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest.ProgressCallback"> <summary> A callback delegate used to get progress messages as the VPC environment is being created. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsRequest.PrivateSubnetCiderBlock"> <summary> Gets and sets the CIDR block you want the private subnet to cover. The default value is "10.0.1.0/24". </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsRequest.PrivateSubnetAvailabilityZone"> <summary> Gets and sets the Availability Zone you want the private subnet in. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsRequest.InstanceType"> <summary> Gets and sets the instance type of the NAT instance. The default value is "m1.small". </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsRequest.KeyName"> <summary> Gets and sets the key name of the NAT instance. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsRequest.ConfigureDefaultVPCGroupForNAT"> <summary> Gets and sets whether the default security group for the VPC should be configured to allow traffic from the EC2 instances to the NAT instance. This means another security group with the name "NATGroup" will be created and a new permission allowing all inbound traffic will be added to the default security group for the VPC. If this VPC is going to be used for AWS Elastic Beanstalk deployments then used this security group as the security group specified for the environment. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVpcAttributeRequest"> <summary> Modifies attributes of a VPC. </summary> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeRequest.WithVpcId(System.String)"> <summary> Sets the VPC ID to describe. </summary> <param name="vpcId">VPC ID to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeRequest.WithEnableDnsSupport(System.Boolean)"> <summary> Sets whether Dns is supported. </summary> <param name="enableDnsSupport">Whether Dns is supported.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeRequest.IsSetEnableDnsSupport"> <summary> Checks if EnableDnsSupport property is set </summary> <returns>true if EnableDnsSupport property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeRequest.WithEnableDnsHostnames(System.Boolean)"> <summary> Sets whether Dns hostnames are enabled. </summary> <param name="enableDnsHostnames">Whether Dns hostnames are enabled.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeRequest.IsSetEnableDnsHostnames"> <summary> Checks if EnableDnsHostnames property is set </summary> <returns>true if Egress property is set</returns> </member> <member name="P:Amazon.EC2.Model.ModifyVpcAttributeRequest.VpcId"> <summary> VPC ID to modify. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcAttributeRequest.EnableDnsSupport"> <summary> Whether Dns is supported. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcAttributeRequest.EnableDnsHostnames"> <summary> Whether Dns hostnames are enabled. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVpcAttributeResponse"> <summary> Modify Vpc Attributes Response </summary> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVpcAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifyVpcAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsResponse"> <summary> This object contains the VPC objects that were created as part of the launch VPC with public and private subnets operation. </summary> </member> <member name="T:Amazon.EC2.Util.LaunchVPCWithPublicSubnetResponse"> <summary> This object contains the VPC objects that were created as part of the launch VPC with public subnet operation. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetResponse.VPC"> <summary> The VPC created. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetResponse.PublicSubnet"> <summary> The public subnet created. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetResponse.InternetGateway"> <summary> The internet gateway that was created and associated with the public subnet. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsResponse.PrivateSubnet"> <summary> The private subnet created. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsResponse.NATInstance"> <summary> The NAT EC2 instance created. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsResponse.NATSecurityGroup"> <summary> The NAT security group created if the ConfigureDefaultVPCGroupForNAT property is set to true. </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesListing"> <summary> Reserved Instances listing </summary> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetReservedInstancesListingId"> <summary> Checks if the ReservedInstancesListingId property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetReservedInstancesId"> <summary> Checks if the ReservedInstancesId property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetCreateDate"> <summary> Checks if the CreateDate property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetUpdateDate"> <summary> Checks if the UpdateDate property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetStatus"> <summary> Checks if the Status property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetStatusMessage"> <summary> Checks if the StatusMessage property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetInstanceCounts"> <summary> Checks if the InstanceCounts property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetPriceSchedules"> <summary> Checks if the PriceSchedules property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetTag"> <summary> Checks if the Tag property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesListing.IsSetClientToken"> <summary> Checks if the ClientToken property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.ReservedInstancesListingId"> <summary> The ID of the Reserved Instance Listing </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.ReservedInstancesId"> <summary> The ID of the Reserved Instance </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.CreateDate"> <summary> The time the listing was created. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.UpdateDate"> <summary> The last-modified timestamp of the listing. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.Status"> <summary> The status of the listing. </summary> <remarks>Possible values = "active", "pending", "cancelled" or "closed"</remarks> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.StatusMessage"> <summary> The reason for current state (can be blank) </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.InstanceCounts"> <summary> Number of instances in the state specified by the Status property. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.PriceSchedules"> <summary> Price of the Reserved Instance listing. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.Tag"> <summary> A list of tags for the Image. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.ClientToken"> <summary> The idempotency token you provided when you created the listing. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest"> <summary> Describes Reserved Instance offerings that are available for purchase. </summary> <remarks> With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithReservedInstancesId(System.String[])"> <summary> Sets the ID of the Reserved Instances to describe. </summary> <param name="list">ID of the Reserved Instances to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetReservedInstancesId"> <summary> Checks if ReservedInstancesId property is set </summary> <returns>true if ReservedInstancesId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithInstanceType(System.String)"> <summary> Sets the instance type on which the Reserved Instance can be used. </summary> <param name="instanceType">The instance type on which the Reserved Instance can be used.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone in which the Reserved Instance can be used. </summary> <param name="availabilityZone">The Availability Zone in which the Reserved Instance can be used.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithProductDescription(System.String)"> <summary> Sets the Reserved Instance description. </summary> <param name="productDescription">The Reserved Instance description.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetProductDescription"> <summary> Checks if ProductDescription property is set </summary> <returns>true if ProductDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstances. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithInstanceTenancy(System.String)"> <summary> Sets the tenancy of the Reserved Instance offering. A Reserved Instance with tenancy of dedicated will run on single-tenant hardware and can only be launched within a VPC. </summary> <param name="instanceTenancy">Instance Tenancy. Valid Values: default | dedicated</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetInstanceTenancy"> <summary> Checks if the InstanceTenancy property is set. </summary> <returns>true if the InstanceTenancy property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithOfferingType(System.String)"> <summary> Sets the Reserved Instance offering type. </summary> <param name="offeringType">Offering type. Valid values: Heavy Utilization | Medium Utilization | Light Utilization</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetOfferingType"> <summary> Checks if the OfferingType property is set. </summary> <returns>true if the OfferingType property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithIncludeMarketplace(System.Boolean)"> <summary> Sets whether to include Reserved Instance Marketplace listings in the response. </summary> <param name="includeMarketplace">True to include Marketplace listings</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetIncludeMarketplace"> <summary> Checks whether the IncludeMarketplace property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithMinDuration(System.Decimal)"> <summary> Sets the minimum duration to filter when searching for offerings. </summary> <param name="minDuration">Duration in seconds; default: 2592000 (1 month)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetMinDuration"> <summary> Checks if the MinDuration property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithMaxDuration(System.Decimal)"> <summary> Sets the maximum duration to filter when searching for offerings. </summary> <param name="maxDuration">Duration in seconds; default: 94608000 (3 years)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetMaxDuration"> <summary> Checks if the MaxDuration property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithMaxInstanceCount(System.Int32)"> <summary> Sets the maximum number of instances to filter when searching for offerings. </summary> <param name="maxInstanceCount">Maximum instance count; default - 20</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetMaxInstanceCount"> <summary> Checks if the MaxInstanceCount property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithMaxResults(System.Int32)"> <summary> Sets the maximum number of offerings to return per call. </summary> <param name="maxResults">Maximum offerings to return; Default: 1000, Maximum: 1000</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetMaxResults"> <summary> Checks if the MaxResults property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.WithNextToken(System.String)"> <summary> Sets the token to get the next page of results. </summary> <param name="nextToken">Token for next page; first page is returned if empty string</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IsSetNextToken"> <summary> Checks if the NextToken property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.ReservedInstancesId"> <summary> ID of the Reserved Instances to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.InstanceType"> <summary> The instance type on which the Reserved Instance can be used. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.AvailabilityZone"> <summary> The Availability Zone in which the Reserved Instance can be used. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.ProductDescription"> <summary> The Reserved Instance description. </summary> <remarks> Instances that include (Amazon VPC) in the description are for use with Amazon VPC. </remarks> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.InstanceTenancy"> <summary> The tenancy of the Reserved Instance offering. </summary> <remarks> A Reserved Instance with tenancy of dedicated will run on single-tenant hardware and can only be launched within a VPC. Valid Values: default | dedicated </remarks> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.OfferingType"> <summary> The Reserved Instance offering type. Valid Values: Heavy Utilization | Medium Utilization | Light Utilization </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IncludeMarketplace"> <summary> Whether to include Marketplace offerings in the response. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MinDuration"> <summary> The minimum duration (in seconds) to filter when searching for offerings. </summary> <remarks>Default: 2592000 (1 month)</remarks> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MaxDuration"> <summary> The maximum duration (in seconds) to filter when searching for offerings. </summary> <remarks> Default: 94608000 (3 years) </remarks> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MaxInstanceCount"> <summary> The maximum number of instances to filter when searching for offerings. </summary> <remarks>Default: 20</remarks> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MaxResults"> <summary> The maximum number of offerings to return per call. </summary> <remarks>Default: 1000, Maximum: 1000</remarks> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.NextToken"> <summary> The token to get the next page of results. </summary> <remarks>Default: First page of results if the string is empty</remarks> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse"> <summary> Describe Reserved Instances Offerings Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse.IsSetDescribeReservedInstancesOfferingsResult"> <summary> Checks if DescribeReservedInstancesOfferingsResult property is set </summary> <returns>true if DescribeReservedInstancesOfferingsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse.DescribeReservedInstancesOfferingsResult"> <summary> Gets and sets the DescribeReservedInstancesOfferingsResult property. Describe Reserved Instances Offerings Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult"> <summary> Describe Reserved Instances Offerings Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.IsSetReservedInstancesOffering"> <summary> Checks if ReservedInstancesOffering property is set </summary> <returns>true if ReservedInstancesOffering property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.IsSetNextToken"> <summary> Checks if NextToken property is set </summary> <returns>true if NextToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.ReservedInstancesOffering"> <summary> Gets and sets the ReservedInstancesOffering property. list of reserved instances offering </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.NextToken"> <summary> Gets and sets the NextToken property. The string marking the next set of results returned. Displays empty if there are no more results to be returned. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesRequest"> <summary> Describes Reserved Instances that you purchased. </summary> <remarks> For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesRequest.WithReservedInstancesId(System.String[])"> <summary> Sets the IDs of the Reserved Instance to describe. </summary> <param name="list">IDs of the Reserved Instance to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesRequest.IsSetReservedInstancesId"> <summary> Checks if ReservedInstancesId property is set </summary> <returns>true if ReservedInstancesId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstancesOfferings. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstancesOfferings. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesRequest.WithOfferingType(System.String)"> <summary> Sets the Reserved Instance offering type. </summary> <param name="offeringType">Offering type. Valid values: Heavy Utilization | Medium Utilization | Light Utilization</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesRequest.IsSetOfferingType"> <summary> Checks if the OfferingType property is set. </summary> <returns>true if the OfferingType property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesRequest.ReservedInstancesId"> <summary> IDs of the Reserved Instance to describe. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified ReservedInstancesOfferings. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesRequest.OfferingType"> <summary> Reserved Instance offering type. Valid Values: Heavy Utilization | Medium Utilization | Light Utilization </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesResponse"> <summary> Describe Reserved Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesResponse.IsSetDescribeReservedInstancesResult"> <summary> Checks if DescribeReservedInstancesResult property is set </summary> <returns>true if DescribeReservedInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesResponse.DescribeReservedInstancesResult"> <summary> Gets and sets the DescribeReservedInstancesResult property. Describe Reserved Instances Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesResult"> <summary> Describe Reserved Instances Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesResult.IsSetReservedInstances"> <summary> Checks if ReservedInstances property is set </summary> <returns>true if ReservedInstances property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeReservedInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesResult.ReservedInstances"> <summary> Gets and sets the ReservedInstances property. List of reserved instances </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRouteTablesRequest"> <summary> Gives you information about your route tables. </summary> <remarks> You can filter the results to return information only about tables that match criteria you specify. For example, you could get information only about a table associated with a particular subnet.You can specify multiple values for the filter. The table must match at least one of the specified values for it to be included in the results. You can specify multiple filters (e.g., the table has a particular route, and is associated with a particular subnet). The result includes information for a particular table only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty. You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesRequest.WithRouteTableId(System.String[])"> <summary> Sets the IDs of the route tables. </summary> <param name="list">IDs of the route tables.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesRequest.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties associated with the specified Tags. </summary> <param name="list">A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesRequest.RouteTableId"> <summary> IDs of the route tables. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesRequest.Filter"> <summary> A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRouteTablesResponse"> <summary> The Response for the DescribeRouteTables operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesResponse.IsSetDescribeRouteTablesResult"> <summary> Checks if DescribeRouteTablesResult property is set </summary> <returns>true if DescribeRouteTablesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesResponse.DescribeRouteTablesResult"> <summary> Gets and sets the DescribeRouteTablesResult property. DescribeRouteTables Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRouteTablesResult"> <summary> DescribeRouteTables Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesResult.IsSetRouteTables"> <summary> Checks if RouteTables property is set </summary> <returns>true if RouteTables property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeRouteTablesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesResult.RouteTables"> <summary> Gets and sets the RouteTables property. A list of route tables. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSecurityGroupsRequest"> <summary> Returns information about security groups that you own. </summary> <remarks> If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsRequest.WithGroupName(System.String[])"> <summary> Sets security group names. </summary> <param name="list">Name of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsRequest.WithGroupId(System.String[])"> <summary> Sets security group IDs. </summary> <param name="list">ID of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsRequest.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified SecurityGroups. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsRequest.GroupName"> <summary> One ore more security group names. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsRequest.GroupId"> <summary> One or more security group IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSecurityGroupsResponse"> <summary> Describe Security Groups Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsResponse.IsSetDescribeSecurityGroupsResult"> <summary> Checks if DescribeSecurityGroupsResult property is set </summary> <returns>true if DescribeSecurityGroupsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsResponse.DescribeSecurityGroupsResult"> <summary> Gets and sets the DescribeSecurityGroupsResult property. Describe Security Groups Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSecurityGroupsResult"> <summary> Describe Security Groups Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsResult.IsSetSecurityGroup"> <summary> Checks if SecurityGroup property is set </summary> <returns>true if SecurityGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSecurityGroupsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsResult.SecurityGroup"> <summary> Gets and sets the SecurityGroup property. List of security groups </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotAttributeRequest"> <summary> Returns information about an attribute of a snapshot. Only one attribute can be specified per call. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.WithSnapshotId(System.String)"> <summary> Sets the ID of the Amazon EBS snapshot. </summary> <param name="snapshotId">The ID of the Amazon EBS snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.WithAttribute(System.String)"> <summary> Sets the snapshot attribute. </summary> <param name="attribute">The snapshot attribute.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.SnapshotId"> <summary> The ID of the Amazon EBS snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.Attribute"> <summary> The snapshot attribute. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotAttributeResponse"> <summary> Describe Snapshot Attribute Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeResponse.IsSetDescribeSnapshotAttributeResult"> <summary> Checks if DescribeSnapshotAttributeResult property is set </summary> <returns>true if DescribeSnapshotAttributeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeResponse.DescribeSnapshotAttributeResult"> <summary> Gets and sets the DescribeSnapshotAttributeResult property. Describe Snapshot Attribute Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotAttributeResult"> <summary> Describe Snapshot Attribute Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeResult.IsSetSnapshotAttribute"> <summary> Checks if SnapshotAttribute property is set </summary> <returns>true if SnapshotAttribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeResult.SnapshotAttribute"> <summary> Gets and sets the SnapshotAttribute property. list of snapshot attributes </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotsRequest"> <summary> Returns information about Amazon EBS snapshots available to the user. </summary> <remarks> Information returned includes volume ID, status, start time, progress, owner ID, volume size, and description. Snapshots available to the user include public snapshots available for any user to launch, private snapshots owned by the user making the request, and private snapshots owned by other users for which the user granted explicit create volume permissions. The create volume permissions fall into 3 categories: public The owner of the snapshot granted create volume permissions for the snapshot to the all group. All users have create volume permissions for these snapshots. explicit The owner of the snapshot granted create volume permissions to a specific user. implicit A user has implicit create volume permissions for all snapshots he or she owns. The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or users with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which the user has create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, a fault is returned. If you specify a snapshot ID for which you do not have access, it will not be included in the returned results. 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, amazon for snapshots owned by Amazon or self for snapshots that you own. If you specify a list of restorable users, only users that have create snapshot permissions for the snapshots are returned. You can specify AWS Account IDs (if you own the snapshot(s)), self for snapshots for which you own or have explicit permissions, or all for public snapshots. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.WithSnapshotId(System.String[])"> <summary> Sets snapshot IDs. </summary> <param name="list">The ID of the Amazon EBS snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.WithOwner(System.String)"> <summary> Sets the owner of the snapshots to return. </summary> <param name="owner">Returns snapshots owned by the specified owner. Valid Values: self | amazon | AWS Account ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.IsSetOwner"> <summary> Checks if Owner property is set </summary> <returns>true if Owner property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.WithRestorableBy(System.String)"> <summary> Sets the Account ID of a user that can create volumes from the snapshot. </summary> <param name="restorableBy">Account ID of a user that can create volumes from the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.IsSetRestorableBy"> <summary> Checks if RestorableBy property is set </summary> <returns>true if RestorableBy property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified Snapshots. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.SnapshotId"> <summary> One or more snapshot IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.Owner"> <summary> Owner of the snapshots to return. Valid Values: self |amazon | AWS Account ID </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.RestorableBy"> <summary> Account ID of a user that can create volumes from the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified Snapshots. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotsResponse"> <summary> Describe Snapshots Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsResponse.IsSetDescribeSnapshotsResult"> <summary> Checks if DescribeSnapshotsResult property is set </summary> <returns>true if DescribeSnapshotsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsResponse.DescribeSnapshotsResult"> <summary> Gets and sets the DescribeSnapshotsResult property. Describe Snapshots Result </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotsResult"> <summary> Describe Snapshots Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsResult.IsSetSnapshot"> <summary> Checks if Snapshot property is set </summary> <returns>true if Snapshot property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsResult.Snapshot"> <summary> Gets and sets the Snapshot property. List of snapshots </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest"> <summary> Describes the datafeed for Spot Instances. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse"> <summary> The Response for the DescribeSpotDatafeedSubscription operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse.IsSetDescribeSpotDatafeedSubscriptionResult"> <summary> Checks if DescribeSpotDatafeedSubscriptionResult property is set </summary> <returns>true if DescribeSpotDatafeedSubscriptionResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse.DescribeSpotDatafeedSubscriptionResult"> <summary> Gets and sets the DescribeSpotDatafeedSubscriptionResult property. Describe Spot Datafeed Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResult"> <summary> Describe Spot Datafeed Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResult.IsSetSpotDatafeedSubscription"> <summary> Checks if SpotDatafeedSubscription property is set </summary> <returns>true if SpotDatafeedSubscription property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResult.SpotDatafeedSubscription"> <summary> Gets and sets the SpotDatafeedSubscription property. The description of the Spot Datafeed subsciption. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest"> <summary> Describes the Spot Instance requests that belong to your account. </summary> <remarks> Spot Instances are instances that automatically launch when your request price exceeds that Spot Price that Amazon EC2 periodically calculates. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.WithSpotInstanceRequestId(System.String[])"> <summary> Sets Spot Instance request IDs. </summary> <param name="list">The ID of the Spot Instance request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.IsSetSpotInstanceRequestId"> <summary> Checks if SpotInstanceRequestId property is set </summary> <returns>true if SpotInstanceRequestId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified SpotInstances. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.SpotInstanceRequestId"> <summary> One or more Spot Instance request IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified SpotInstances. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse"> <summary> The Response for the DescribeSpotInstanceRequests operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse.IsSetDescribeSpotInstanceRequestsResult"> <summary> Checks if DescribeSpotInstanceRequestsResult property is set </summary> <returns>true if DescribeSpotInstanceRequestsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse.DescribeSpotInstanceRequestsResult"> <summary> Gets and sets the DescribeSpotInstanceRequestsResult property. The Result of the Describe Spot Instances operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotInstanceRequestsResult"> <summary> The Result of the Describe Spot Instances operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsResult.IsSetSpotInstanceRequest"> <summary> Checks if SpotInstanceRequest property is set </summary> <returns>true if SpotInstanceRequest property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotInstanceRequestsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsResult.SpotInstanceRequest"> <summary> Gets and sets the SpotInstanceRequest property. A list of the SpotInstanceRequest objects returned by the service. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest"> <summary> Describes the Spot Price history. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithStartTime(System.String)"> <summary> Sets the start date and time of the Spot Instance price history data. </summary> <param name="startTime">Start date and time of the Spot Instance price history data.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetStartTime"> <summary> Checks if StartTime property is set </summary> <returns>true if StartTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithEndTime(System.String)"> <summary> Sets end date and time of the Spot Instance price history data. </summary> <param name="endTime">End date and time of the Spot Instance price history data.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetEndTime"> <summary> Checks if EndTime property is set </summary> <returns>true if EndTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithInstanceType(System.String[])"> <summary> Sets instance types to return. </summary> <param name="list">A list of instance types.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithProductDescription(System.String[])"> <summary> Sets a list of AMI descriptions to filter by. </summary> <param name="list">A list of AMI descriptions</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetProductDescription"> <summary> Checks if ProductDescription property is set </summary> <returns>true if ProductDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified SpotPriceHistory. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified SpotPriceHistory. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithAvailabilityZone(System.String)"> <summary> Sets the availability zone to filter the results by. </summary> <param name="availabilityZone">Filters the results by availability zone.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithMaxResults(System.Int32)"> <summary> Sets the number of rows to return. </summary> <param name="maxResults">Specifies the number of rows to return.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetMaxResults"> <summary> Checks if MaxResults property is set </summary> <returns>true if MaxResults property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.WithNextToken(System.String)"> <summary> Sets the token for the next set of rows to return. </summary> <param name="nextToken">Specifies the next set of rows to return.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.IsSetNextToken"> <summary> Checks if NextToken property is set </summary> <returns>true if NextToken property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.StartTime"> <summary> Start date and time of the Spot Instance price history data. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.EndTime"> <summary> End date and time of the Spot Instance price history data. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.InstanceType"> <summary> One ore more instance types to return. <remarks> Valid values: m1.small | m1.large | m1.xlarge | c1.medium | c1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | m3.xlarge | m3.2xlarge | t1.micro </remarks> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.ProductDescription"> <summary> A list of AMI descriptions to filter by. </summary> <remarks> Valie values: Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC) </remarks> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.Filter"> <summary> A list of filters used to match system-defined properties and user-defined tags associated with the specified SpotPriceHistory. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.AvailabilityZone"> <summary> Availability zone to filter the results by. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.MaxResults"> <summary> The number of rows to return. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.NextToken"> <summary> Token for the next set of rows to return. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse"> <summary> The list of cancelled Spot Instance requests. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse.IsSetDescribeSpotPriceHistoryResult"> <summary> Checks if DescribeSpotPriceHistoryResult property is set </summary> <returns>true if DescribeSpotPriceHistoryResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse.DescribeSpotPriceHistoryResult"> <summary> Gets and sets the DescribeSpotPriceHistoryResult property. The Result containing the Spot Price history data. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotPriceHistoryResult"> <summary> The Result containing the Spot Price history data. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.IsSetSpotPriceHistory"> <summary> Checks if SpotPriceHistory property is set </summary> <returns>true if SpotPriceHistory property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.IsSetNextToken"> <summary> Checks if NextToken property is set </summary> <returns>true if NextToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.SpotPriceHistory"> <summary> Gets and sets the SpotPriceHistory property. List of data points specifying the Spot Price history. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.NextToken"> <summary> Gets and sets the NextToken property. The string marking the next set of results returned. Displays empty if there are no more results to be returned. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSubnetsRequest"> <summary> Gives you information about your subnets. </summary> <remarks> You can filter the results to return information only about subnets that match criteria you specify. For example, you could ask to get information about a particular subnet (or all) only if the subnet's state is available. You can specify multiple filters (e.g., the subnet is in a particular VPC, and the subnet's state is available). The result includes information for a particular subnet only if the subnet matches all your filters. If there's no match, no special message is returned; the response is simply empty </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsRequest.WithSubnetId(System.String[])"> <summary> Sets subnet IDs. </summary> <param name="list">A subnet ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsRequest.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filter to apply on the results of DescribeSubnets. </summary> <param name="list">The filter to apply on the results of DescribeSubnets. Filters can be: a. state - The state of the subnet. (pending, available). b. vpcId - The ID of the VPC the subnet is in. c. cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. Constraints: Must contain the slash followed by one or two digits (e.g., /28) d. - The Availability Zone the subnet is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsRequest.SubnetId"> <summary> One or more subnet IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsRequest.Filter"> <summary> One or more filters. <ul> <li> <c>availabilityZone</c> - The Availability Zone for the subnet. You can also use <c>availability-zone</c> as the filter name. </li> <li> <c>available-ip-address-count</c> - The number of IP addresses in the subnet that are available. </li> <li> <c>cidrBlock</c> - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use <c>cidr</c> or <c>cidr-block</c> as the filter names. </li> <li> <c>defaultForAz</c> - Indicates whether this is the default subnet for the Availability Zone. You can also use <c>default-for-az</c> as the filter name. </li> <li> <c>state</c> - The state of the subnet (<c>pending</c> | <c>available</c>). </li> <li> <c>subnet-id</c> - The ID of the subnet. </li> <li> <c>tag</c>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </li> <li> <c>tag-key</c> - The key of a tag assigned to the resource. This filter is independent of the <c>tag-value</c> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <c>tag</c>:<i>key</i>=<i>value</i> filter. </li> <li> <c>tag-value</c> - The value of a tag assigned to the resource. This filter is independent of the <c>tag-key</c> filter. </li> <li> <c>vpc-id</c> - The ID of the VPC for the subnet. </li> </ul> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSubnetsResponse"> <summary> Describe Subnets Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsResponse.IsSetDescribeSubnetsResult"> <summary> Checks if DescribeSubnetsResult property is set </summary> <returns>true if DescribeSubnetsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsResponse.DescribeSubnetsResult"> <summary> Gets and sets the DescribeSubnetsResult property. Describe Subnets Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSubnetsResult"> <summary> Describe Subnets Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsResult.IsSetSubnet"> <summary> Checks if Subnet property is set </summary> <returns>true if Subnet property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeSubnetsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsResult.Subnet"> <summary> Gets and sets the Subnet property. List of subnets </summary> </member> <member name="T:Amazon.EC2.Model.DescribeTagsRequest"> <summary> Describes Tags for the specified resources. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeTagsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties associated with the specified Tags. </summary> <param name="list">A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeTagsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeTagsRequest.Filter"> <summary> A list of filters used to match system-defined properties associated with the specified Tags. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeTagsResponse"> <summary> The Response for the DescribeTags operation. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeTagsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeTagsResponse.IsSetDescribeTagsResult"> <summary> Checks if DescribeTagsResult property is set </summary> <returns>true if DescribeTagsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeTagsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeTagsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeTagsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeTagsResponse.DescribeTagsResult"> <summary> Gets and sets the DescribeTagsResult property. DescribeTags Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeTagsResult"> <summary> DescribeTags Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeTagsResult.IsSetResourceTag"> <summary> Checks if ResourceTag property is set </summary> <returns>true if ResourceTag property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeTagsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeTagsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeTagsResult.ResourceTag"> <summary> Gets and sets the ResourceTag property. A list of tags for the specified resources. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeAttributeRequest"> <summary> Describes an attribute of a volume. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeRequest.WithVolumeId(System.String)"> <summary> Sets the volume against which to make the describe call. </summary> <param name="volumeId">The new volume id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeRequest.WithAttribute(System.String)"> <summary> Sets the instance attribute being described. </summary> <param name="attribute">The new attribute</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeRequest.VolumeId"> <summary> The volume against which to make the describe call. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeRequest.Attribute"> <summary> The instance attribute being described. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeAttributeResponse"> <summary> Describe Volume Attribute response. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResponse.IsSetDescribeVolumeAttributeResult"> <summary> Checks if DescribeVolumeAttributeResult property is set </summary> <returns>true if DescribeVolumeAttributeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResponse.DescribeVolumeAttributeResult"> <summary> Gets and sets the DescribeVolumeAttributeResult property. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeAttributeResult"> <summary> Describe Volume Attribute result. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResult.IsSetAutoEnableIO"> <summary> Checks if AutoEnableIO property is set </summary> <returns>true if AutoEnableIO property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResult.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResult.IsSetProductCodes"> <summary> Checks if ProductCodes property is set </summary> <returns>true if ProductCodes property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeAttributeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResult.AutoEnableIO"> <summary> Flag that signals if the AutoEnableIO attribute is true or false. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResult.VolumeId"> <summary> Volume ID of the target volume. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResult.ProductCodes"> <summary> Product codes for the volume. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumesRequest"> <summary> Describes the specified Amazon EBS volumes that you own. </summary> <remarks> If you do not specify one or more volume IDs, Amazon EBS describes all volumes that you own. For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesRequest.WithVolumeId(System.String[])"> <summary> Sets volume IDs. </summary> <param name="list">The ID of the volume to list.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to match system-defined properties and user-defined tags associated with the specified Volumes. </summary> <param name="list">A list of filters used to match system-defined properties and user-defined tags associated with the specified Volumes. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesRequest.VolumeId"> <summary> One or more volume IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesRequest.Filter"> <summary> One or more filters. <ul> <li> <c>attachment.attach-time</c> - The time stamp when the attachment initiated. </li> <li> <c>attachment.delete-on-termination</c> - Whether the volume is deleted on instance termination. </li> <li> <c>attachment.device</c> - The device name that is exposed to the instance (for example, <c>/dev/sda1</c>). </li> <li> <c>attachment.instance-id</c> - The ID of the instance the volume is attached to. </li> <li> <c>attachment.status</c> - The attachment state (<c>attaching</c> | <c>attached</c> | <c>detaching</c> | <c>detached</c>). </li> <li> <c>availability-zone</c> - The Availability Zone in which the volume was created. </li> <li> <c>create-time</c> - The time stamp when the volume was created. </li> <li> <c>encrypted</c> - The encryption status of the volume. </li> <li> <c>size</c> - The size of the volume, in GiB. </li> <li> <c>snapshot-id</c> - The snapshot from which the volume was created. </li> <li> <c>status</c> - The status of the volume (<c>creating</c> | <c>available</c> | <c>in-use</c> | <c>deleting</c> | <c>deleted</c> | <c>error</c>). </li> <li> <c>tag</c>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </li> <li> <c>tag-key</c> - The key of a tag assigned to the resource. This filter is independent of the <c>tag-value</c> filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <c>tag</c>:<i>key</i>=<i>value</i> filter. </li> <li> <c>tag-value</c> - The value of a tag assigned to the resource. This filter is independent of the <c>tag-key</c> filter. </li> <li> <c>volume-id</c> - The volume ID. </li> <li> <c>volume-type</c> - The Amazon EBS volume type. This can be <c>gp2</c> for General Purpose (SSD) volumes, <c>io1</c> for Provisioned IOPS (SSD) volumes, or <c>standard</c> for Magnetic volumes. </li> </ul> </summary> [XmlElementAttribute(ElementName = "Filter")] </member> <member name="T:Amazon.EC2.Model.DescribeVolumesResponse"> <summary> Describe Volumes Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesResponse.IsSetDescribeVolumesResult"> <summary> Checks if DescribeVolumesResult property is set </summary> <returns>true if DescribeVolumesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesResponse.DescribeVolumesResult"> <summary> Gets and sets the DescribeVolumesResult property. Describe Volumes Result </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumesResult"> <summary> Describe Volumes Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesResult.IsSetVolume"> <summary> Checks if Volume property is set </summary> <returns>true if Volume property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesResult.Volume"> <summary> Gets and sets the Volume property. List of volumes </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeStatusRequest"> <summary> Returns the status of one or more volumes. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.WithVolumeId(System.String[])"> <summary> Sets list of volume IDs to retrieve statuses for. </summary> <param name="list">Volume IDs to describe.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to specify which volumes to return. </summary> <param name="list">A list of filters used to specify which volumes to return. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.WithNextToken(System.String)"> <summary> Sets the token specifying the next paginated set of results to return. </summary> <param name="nextToken"></param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.IsSetNextToken"> <summary> Checks if the NextToken property is set. </summary> <returns>true if NextToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.WithMaxResults(System.Int32)"> <summary> Sets the maximum number of paginated volume items per response. </summary> <param name="maxResults">Maximum number of paginated volume items</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusRequest.IsSetMaxResults"> <summary> Checks if the MaxResults property is set. </summary> <returns>true if MaxResults property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.VolumeId"> <summary> List of volume IDs to retrieve statuses for. If not specified, all volumes are described. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.Filter"> <summary> A list of filters used to specify which volumes to return. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.NextToken"> <summary> Token specifying the next paginated set of results to return. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.MaxResults"> <summary> The maximum number of paginated volume items per response. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeStatusResponse"> <summary> Describe Volume Status response. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResponse.IsSetDescribeVolumeStatusResult"> <summary> Checks if DescribeVolumeStatusResult property is set </summary> <returns>true if DescribeVolumeStatusResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusResponse.DescribeVolumeStatusResult"> <summary> Gets and sets the DescribeVolumeStatusResult property. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeStatusResult"> <summary> Describe Volume Status result. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResult.IsSetVolumeStatus"> <summary> Checks if the VolumeStatus property is set </summary> <returns>true if the VolumeStatus property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResult.IsSetNextToken"> <summary> Checks if the NextToken property is set </summary> <returns>true if the NextToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVolumeStatusResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusResult.VolumeStatus"> <summary> Status of requested volumes. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusResult.NextToken"> <summary> Gets and sets the NextToken property. A string specifying the next paginated set of results to return. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcsRequest"> <summary> Gives you information about your VPCs. </summary> <remarks> You can filter the results to return information only about VPCs that match criteria you specify. For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC's state is available). The result includes information for a particular VPC only if the VPC matches all your filters. If there's no match, no special message is returned; the response is simply empty. The information returned consists of: a) The VPC ID. b) The CIDR block you've assigned to the VPC. c) The ID of the DHCP options you've associated with the VPC (or "default" if the default options are associated with the VPC) The current state of the VPC (pending or available) </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsRequest.WithVpcId(System.String[])"> <summary> Sets list of VPC IDs for which you want information. </summary> <param name="list">The ID of a VPC you want information about.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets filters used to specify which VPCs to describe. </summary> <param name="list">The available filters are: 1. state - The state of the VPC. Valid Values: pending, available. 2. cidrBlock - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Constraints: Must contain the slash followed by one or two digits (e.g., /28). 3. dhcpOptionsId - The IP of a set of DHCP options.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsRequest.VpcId"> <summary> List of VPC IDs for which you want information. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsRequest.Filter"> <summary> List of filters used to specify which VPCs to describe. The available filters are: 1. state - The state of the VPC. Valid Values: pending, available. 2. cidrBlock - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Constraints: Must contain the slash followed by one or two digits (e.g., /28). 3. dhcpOptionsId - The IP of a set of DHCP options. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcsResponse"> <summary> Describe VPCs Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsResponse.IsSetDescribeVpcsResult"> <summary> Checks if DescribeVpcsResult property is set </summary> <returns>true if DescribeVpcsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsResponse.DescribeVpcsResult"> <summary> Gets and sets the DescribeVpcsResult property. Describe Vpcs Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcsResult"> <summary> Describe Vpcs Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsResult.IsSetVpc"> <summary> Checks if Vpc property is set </summary> <returns>true if Vpc property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpcsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsResult.Vpc"> <summary> Gets and sets the Vpc property. List of VPCs </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnConnectionsRequest"> <summary> Gives you information about your VPN connections. Important - we strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. You can filter the results to return information only about VPN connections that match criteria you specify. For example, you could ask to get information about a particular VPN connection (or all) only if the VPN's state is pending or available. You can specify multiple filters (e.g., the VPN connection is associated with a particular VPN gateway, and the gateway's state is pending or available). The result includes information for a particular VPN connection only if the VPN connection matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN connection ID. 2. The type of connection. 3. Customer gateway ID. 4. VPN gateway ID. 5. The current state of the VPN connection (pending, available, deleting, deleted). 6. The customer gateway configuration information in the native XML format. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsRequest.WithVpnConnectionId(System.String[])"> <summary> Sets VPN connection IDs. </summary> <param name="list">A VPN connection ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsRequest.IsSetVpnConnectionId"> <summary> Checks if VpnConnectionId property is set </summary> <returns>true if VpnConnectionId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filter to apply on the results of DescribeVpnConnections. </summary> <param name="list">The filter to apply on the results of DescribeVpnConnections.</param> <returns>this instance</returns> <remarks> Filters can be: a. state - The state of the VPN connection. (pending, available, deleting, deleted). b. type - The type of VPN connection. Currently the only supported type is ipsec.1. c. customer-gateway-id - The ID of a customer gateway associated with the VPN connection. d. vpn-gateway-id - The ID of a VPN gateway associated with the VPN connection. e. vpn-connection-id - the ID of the VPN connection. f. customer-gateway-configuration - the configuration information for the customer gateway. g. options.static-routes-only - indicates whether the connection has static routes only (used for devices that do not support BGP). h. route.destination-cidr-block - the destination CIDR block; this corresponds to the subnet used in a customer data center. i. bgp-asn - the BGP ASN associated with a BGP device. j. tag-key - the key of a tag assigned to the resource (this filter is independent of the tag-value filter). k. tag-value - the value of a tag assigned to the resource (this filter is independent of the tag-key filter). l. tag:key - Filters the results based on a specific tag/value combination. Example: To list just the resources assigned tag Purpose=X, then specify: Filter.1.Name=tag:Purpose and Filter.1.Value.1=X. Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify: Filter.1.Name=tag:Purpose and Filter.1.Value.1=X and Filter.1.Value.2=Y. </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsRequest.VpnConnectionId"> <summary> One or more VPN connection IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsRequest.Filter"> <summary> The filter to apply on the results of DescribeVpnConnections. </summary> <remarks> Filters can be: a. state - The state of the VPN connection. (pending, available, deleting, deleted). b. type - The type of VPN connection. Currently the only supported type is ipsec.1. c. customer-gateway-id - The ID of a customer gateway associated with the VPN connection. d. vpn-gateway-id - The ID of a VPN gateway associated with the VPN connection. e. vpn-connection-id - the ID of the VPN connection. f. customer-gateway-configuration - the configuration information for the customer gateway. g. options.static-routes-only - indicates whether the connection has static routes only (used for devices that do not support BGP). h. route.destination-cidr-block - the destination CIDR block; this corresponds to the subnet used in a customer data center. i. bgp-asn - the BGP ASN associated with a BGP device. j. tag-key - the key of a tag assigned to the resource (this filter is independent of the tag-value filter). k. tag-value - the value of a tag assigned to the resource (this filter is independent of the tag-key filter). l. tag:key - Filters the results based on a specific tag/value combination. Example: To list just the resources assigned tag Purpose=X, then specify: Filter.1.Name=tag:Purpose and Filter.1.Value.1=X. Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify: Filter.1.Name=tag:Purpose and Filter.1.Value.1=X and Filter.1.Value.2=Y. </remarks> </member> <member name="T:Amazon.EC2.Model.DescribeVpnConnectionsResponse"> <summary> Describe Vpn Connections Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsResponse.IsSetDescribeVpnConnectionsResult"> <summary> Checks if DescribeVpnConnectionsResult property is set </summary> <returns>true if DescribeVpnConnectionsResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsResponse.DescribeVpnConnectionsResult"> <summary> Gets and sets the DescribeVpnConnectionsResult property. Describe Vpn Connections Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnConnectionsResult"> <summary> Describe Vpn Connections Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsResult.IsSetVpnConnection"> <summary> Checks if VpnConnection property is set </summary> <returns>true if VpnConnection property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnConnectionsResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsResult.VpnConnection"> <summary> Gets and sets the VpnConnection property. List of vpn connections </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnGatewaysRequest"> <summary> Gives you information about your VPN gateways. </summary> <remarks> You can filter the results to return information only about VPN gateways that match criteria you specify. For example, you could ask to get information about a particular VPN gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the VPN gateway is in a particular Availability Zone and the gateway's state is pending or available). The result includes information for a particular VPN gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. The returned information consists of: 1. The VPN gateway ID - The current state of the VPN gateway (pending, available, deleting, deleted) 2. The type of VPN connection the VPN gateway supports. 3. The Availability Zone where the VPN gateway was created. 4. The VPCs the VPN gateway is attached to and the state of each attachment (attaching, attached, detaching, detached) </remarks> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysRequest.WithVpnGatewayId(System.String[])"> <summary> Sets VPN gateway IDs. </summary> <param name="list">A VPN gateway ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysRequest.IsSetVpnGatewayId"> <summary> Checks if VpnGatewayId property is set </summary> <returns>true if VpnGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysRequest.WithFilter(Amazon.EC2.Model.Filter[])"> <summary> Sets the filter to apply on the results of DescribeVpnGateways. </summary> <param name="list">The filter to apply on the results of DescribeVpnGateways. Filters can be: a. state - The state of the VPN gateway. (pending, available, deleting, deleted). b. type - The type of VPN gateway. Currently the only supported type is ipsec.1. c. availabilityZone - The Availability Zone the VPN gateway is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysRequest.IsSetFilter"> <summary> Checks if Filter property is set </summary> <returns>true if Filter property is set</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysRequest.VpnGatewayId"> <summary> One or more VPN gateway IDs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysRequest.Filter"> <summary> The filter to apply on the results of DescribeVpnGateways. Filters can be: a. state - The state of the VPN gateway. (pending, available, deleting, deleted). b. type - The type of VPN gateway. Currently the only supported type is ipsec.1. c. availabilityZone - The Availability Zone the VPN gateway is in. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnGatewaysResponse"> <summary> Describe Vpn Gateways Response </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysResponse.IsSetDescribeVpnGatewaysResult"> <summary> Checks if DescribeVpnGatewaysResult property is set </summary> <returns>true if DescribeVpnGatewaysResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysResponse.DescribeVpnGatewaysResult"> <summary> Gets and sets the DescribeVpnGatewaysResult property. Describe Vpn Gateways Result </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnGatewaysResult"> <summary> Describe Vpn Gateways Result </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysResult.IsSetVpnGateway"> <summary> Checks if VpnGateway property is set </summary> <returns>true if VpnGateway property is set</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DescribeVpnGatewaysResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysResult.VpnGateway"> <summary> Gets and sets the VpnGateway property. List of VPN gateways </summary> </member> <member name="T:Amazon.EC2.Model.DetachInternetGatewayRequest"> <summary> Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. </summary> <remarks> The VPC must not contain any running instances with elastic IP addresses. For more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.DetachInternetGatewayRequest.WithInternetGatewayId(System.String)"> <summary> Sets the ID of the Internet gateway to detach. </summary> <param name="internetGatewayId">The ID of the Internet gateway to attach.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachInternetGatewayRequest.IsSetInternetGatewayId"> <summary> Checks if InternetGatewayId property is set </summary> <returns>true if InternetGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachInternetGatewayRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC. </summary> <param name="vpcId">The ID of the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachInternetGatewayRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DetachInternetGatewayRequest.InternetGatewayId"> <summary> The ID of the Internet gateway to detach. </summary> </member> <member name="P:Amazon.EC2.Model.DetachInternetGatewayRequest.VpcId"> <summary> The ID of the VPC. </summary> </member> <member name="T:Amazon.EC2.Model.DetachInternetGatewayResponse"> <summary> The Response for the DetachInternetGateway operation. </summary> </member> <member name="M:Amazon.EC2.Model.DetachInternetGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachInternetGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DetachInternetGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DetachInternetGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DetachNetworkInterfaceRequest"> <summary> Detaches a network interface from an instance. </summary> </member> <member name="M:Amazon.EC2.Model.DetachNetworkInterfaceRequest.WithAttachmentId(System.String)"> <summary> Sets the ID of the attachment to detach </summary> <param name="attachmentId">ID of the attachment</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachNetworkInterfaceRequest.IsSetAttachmentId"> <summary> Checks if the AttachmentId property is set </summary> <returns>true if the AttachmentId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachNetworkInterfaceRequest.WithForce(System.Boolean)"> <summary> Sets whether to force the detachment </summary> <param name="force">Set to true to force a detachment.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachNetworkInterfaceRequest.IsSetForce"> <summary> Checks if the Force property is set </summary> <returns>true if the Force property is set</returns> </member> <member name="P:Amazon.EC2.Model.DetachNetworkInterfaceRequest.AttachmentId"> <summary> The ID of the attachment to detach. </summary> </member> <member name="P:Amazon.EC2.Model.DetachNetworkInterfaceRequest.Force"> <summary> Whether to force the detachment </summary> </member> <member name="T:Amazon.EC2.Model.DetachNetworkInterfaceResponse"> <summary> Detach Network Interface response </summary> </member> <member name="M:Amazon.EC2.Model.DetachNetworkInterfaceResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachNetworkInterfaceResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DetachNetworkInterfaceResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DetachNetworkInterfaceResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DetachVolumeRequest"> <summary> Detaches an Amazon EBS volume from an instance. </summary> <remarks> For more information about Amazon EBS, go to the Amazon Elastic Compute Cloud Developer Guide. Important - make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to unmount file systems, or otherwise properly release the device from use, can result in lost data and will corrupt the file system. </remarks> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.WithVolumeId(System.String)"> <summary> Sets the ID of the volume. </summary> <param name="volumeId">The ID of the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance. </summary> <param name="instanceId">The ID of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.WithDevice(System.String)"> <summary> Sets the device name. </summary> <param name="device">The device name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.IsSetDevice"> <summary> Checks if Device property is set </summary> <returns>true if Device property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.WithForce(System.Boolean)"> <summary> Sets whether to force detachment. </summary> <param name="force">Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.IsSetForce"> <summary> Checks if Force property is set </summary> <returns>true if Force property is set</returns> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.VolumeId"> <summary> The ID of the volume. </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.InstanceId"> <summary> The ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.Device"> <summary> The device name. </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.Force"> <summary> Whether to force detachment. </summary> <remarks> Forces detachment if the previous detachment attempt did not occur cleanly (logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. </remarks> </member> <member name="T:Amazon.EC2.Model.DetachVolumeResponse"> <summary> Detach Volume Response </summary> </member> <member name="M:Amazon.EC2.Model.DetachVolumeResponse.IsSetDetachVolumeResult"> <summary> Checks if DetachVolumeResult property is set </summary> <returns>true if DetachVolumeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DetachVolumeResponse.DetachVolumeResult"> <summary> Gets and sets the DetachVolumeResult property. Detach Volume Result </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DetachVolumeResult"> <summary> Detach Volume Result </summary> </member> <member name="M:Amazon.EC2.Model.DetachVolumeResult.IsSetAttachment"> <summary> Checks if Attachment property is set </summary> <returns>true if Attachment property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DetachVolumeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DetachVolumeResult.Attachment"> <summary> Gets and sets the Attachment property. Volume attachment </summary> </member> <member name="T:Amazon.EC2.Model.DetachVpnGatewayRequest"> <summary> Detaches a VPN gateway from a VPC. </summary> <remarks> You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a VPN gateway has been completely detached from a VPC by describing the VPN gateway (any attachments to the VPN gateway are also described). You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the VPN gateway. </remarks> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayRequest.WithVpnGatewayId(System.String)"> <summary> Sets the ID of the VPN gateway you want to detach from the VPC </summary> <param name="vpnGatewayId">The ID of the VPN gateway you want to detach from the VPC</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayRequest.IsSetVpnGatewayId"> <summary> Checks if VpnGatewayId property is set </summary> <returns>true if VpnGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayRequest.WithVpcId(System.String)"> <summary> Sets the ID of the VPC you want to detach the VPN gateway from. </summary> <param name="vpcId">The ID of the VPC you want to detach the VPN gateway from.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayRequest.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DetachVpnGatewayRequest.VpnGatewayId"> <summary> The ID of the VPN gateway you want to detach from the VPC </summary> </member> <member name="P:Amazon.EC2.Model.DetachVpnGatewayRequest.VpcId"> <summary> The ID of the VPC you want to detach the VPN gateway from. </summary> </member> <member name="T:Amazon.EC2.Model.DetachVpnGatewayResponse"> <summary> Detach Vpn Gateway Response </summary> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DetachVpnGatewayResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DhcpConfiguration"> <summary> DHCP Configuration </summary> </member> <member name="M:Amazon.EC2.Model.DhcpConfiguration.WithKey(System.String)"> <summary> Sets the name of a DHCP option. </summary> <param name="key">The name of a DHCP option.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DhcpConfiguration.IsSetKey"> <summary> Checks if Key property is set </summary> <returns>true if Key property is set</returns> </member> <member name="M:Amazon.EC2.Model.DhcpConfiguration.WithValue(System.String[])"> <summary> Sets the values for the DHCP option. </summary> <param name="list">A value for the DHCP option.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DhcpConfiguration.IsSetValue"> <summary> Checks if Value property is set </summary> <returns>true if Value property is set</returns> </member> <member name="P:Amazon.EC2.Model.DhcpConfiguration.Key"> <summary> The name of a DHCP option. </summary> </member> <member name="P:Amazon.EC2.Model.DhcpConfiguration.Value"> <summary> Values for the DHCP option. </summary> </member> <member name="T:Amazon.EC2.Model.DhcpOptions"> <summary> DHCP Options </summary> </member> <member name="M:Amazon.EC2.Model.DhcpOptions.WithDhcpOptionsId(System.String)"> <summary> Sets the ID of the set of DHCP options </summary> <param name="dhcpOptionsId">The ID of the set of DHCP options</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DhcpOptions.IsSetDhcpOptionsId"> <summary> Checks if DhcpOptionsId property is set </summary> <returns>true if DhcpOptionsId property is set</returns> </member> <member name="M:Amazon.EC2.Model.DhcpOptions.WithConfiguration(Amazon.EC2.Model.DhcpConfiguration[])"> <summary> Sets the information about the set of DHCP options </summary> <param name="list">Information about the set of DHCP options</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DhcpOptions.IsSetConfiguration"> <summary> Checks if Configuration property is set </summary> <returns>true if Configuration property is set</returns> </member> <member name="M:Amazon.EC2.Model.DhcpOptions.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the list of tags for the DhcpOptions. </summary> <param name="list">A list of tags for the DhcpOptions.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DhcpOptions.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.DhcpOptions.DhcpOptionsId"> <summary> The ID of the set of DHCP options </summary> </member> <member name="P:Amazon.EC2.Model.DhcpOptions.Configuration"> <summary> Information about the set of DHCP options </summary> </member> <member name="P:Amazon.EC2.Model.DhcpOptions.Tag"> <summary> List of tags for the DhcpOptions. </summary> </member> <member name="T:Amazon.EC2.Model.DisableVGWRoutePropagationRequest"> <summary> Disables a virtual private gateway (VGW) from propagating routes to the routing tables of an Amazon VPC. </summary> </member> <member name="M:Amazon.EC2.Model.DisableVGWRoutePropagationRequest.WithRouteTableId(System.String)"> <summary> Sets the ID of the routing table. </summary> <param name="routeTableId">Routing table id</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.DisableVGWRoutePropagationRequest.IsSetRouteTableId"> <summary> Checks is the RouteTableId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.DisableVGWRoutePropagationRequest.WithGatewayId(System.String)"> <summary> Sets the ID of the Virtual Private Gateway. </summary> <param name="gatewayId">Gateway Id</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.DisableVGWRoutePropagationRequest.IsSetGatewayId"> <summary> Checks if the GatewayId property is set </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.DisableVGWRoutePropagationRequest.RouteTableId"> <summary> The ID of the routing table. </summary> </member> <member name="P:Amazon.EC2.Model.DisableVGWRoutePropagationRequest.GatewayId"> <summary> The ID of the Virtual Private Gateway. </summary> </member> <member name="T:Amazon.EC2.Model.DisableVGWRoutePropagationResponse"> <summary> Disable Virtual Gateway (VGW) Route Propagation Response </summary> </member> <member name="M:Amazon.EC2.Model.DisableVGWRoutePropagationResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DisableVGWRoutePropagationResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DisableVGWRoutePropagationResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DisableVGWRoutePropagationResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DisassociateAddressRequest"> <summary> Disassociates the specified elastic IP address from the instance to which it is assigned. </summary> <remarks> This is an idempotent operation. If you call it more than once, Amazon EC2 does not return an error. </remarks> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressRequest.WithPublicIp(System.String)"> <summary> Sets the IP address that you are disassociating from the instance. </summary> <param name="publicIp">IP address that you are disassociating from the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressRequest.IsSetPublicIp"> <summary> Checks if PublicIp property is set </summary> <returns>true if PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressRequest.WithAssociationId(System.String)"> <summary> Sets the Association ID corresponding to the VPC elastic IP address you want to disassociate. </summary> <param name="associationId">Association ID corresponding to the VPC elastic IP address you want to disassociate. Condition: Required for VPC elastic IP addresses</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressRequest.IsSetAssociationId"> <summary> Checks if AssociationId property is set </summary> <returns>true if AssociationId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DisassociateAddressRequest.PublicIp"> <summary> IP address that you are disassociating from the instance. </summary> </member> <member name="P:Amazon.EC2.Model.DisassociateAddressRequest.AssociationId"> <summary> Association ID corresponding to the VPC elastic IP address you want to disassociate. Condition: Required for VPC elastic IP addresses </summary> </member> <member name="T:Amazon.EC2.Model.DisassociateAddressResponse"> <summary> Disassociate Address Response </summary> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DisassociateAddressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.DisassociateRouteTableRequest"> <summary> Disassociates a subnet from a route table. </summary> <remarks> 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, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.DisassociateRouteTableRequest.WithAssociationId(System.String)"> <summary> Sets the association ID representing the current association between the route table and subnet. </summary> <param name="associationId">The association ID representing the current association between the route table and subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateRouteTableRequest.IsSetAssociationId"> <summary> Checks if AssociationId property is set </summary> <returns>true if AssociationId property is set</returns> </member> <member name="P:Amazon.EC2.Model.DisassociateRouteTableRequest.AssociationId"> <summary> The association ID representing the current association between the route table and subnet. </summary> </member> <member name="T:Amazon.EC2.Model.DisassociateRouteTableResponse"> <summary> The Response for the DisassociateRouteTable operation. </summary> </member> <member name="M:Amazon.EC2.Model.DisassociateRouteTableResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateRouteTableResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.DisassociateRouteTableResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.DisassociateRouteTableResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.WithFormat(System.String)"> <summary> Sets the disk image format. </summary> <param name="format">Disk image format. Valid Values: VMDK | RAW</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.IsSetFormat"> <summary> Checks if Format property is set </summary> <returns>true if Format property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.WithSize(System.Decimal)"> <summary> Sets the size of the disk image. </summary> <param name="size">Size of the disk image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.IsSetSize"> <summary> Checks if Size property is set </summary> <returns>true if Size property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.WithImportManifestUrl(System.String)"> <summary> Sets the presigned URL for the import manifest stored in Amazon S3. </summary> <param name="importManifestUrl">The manifest for the disk image, stored in Amazon S3 and presented here as an Amazon S3 pre-signed URL. For information about creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.IsSetImportManifestUrl"> <summary> Checks if ImportManifestUrl property is set </summary> <returns>true if ImportManifestUrl property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.WithChecksum(System.String)"> <summary> Sets the checksum computed for the disk image. </summary> <param name="checksum">Checksum computed for the disk image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDescriptionType.IsSetChecksum"> <summary> Checks if Checksum property is set </summary> <returns>true if Checksum property is set</returns> </member> <member name="P:Amazon.EC2.Model.DiskImageDescriptionType.Format"> <summary> Disk image format. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDescriptionType.Size"> <summary> Size of the disk image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDescriptionType.ImportManifestUrl"> <summary> A presigned URL for the import manifest stored in Amazon S3. </summary> <remarks> For information about creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide. </remarks> </member> <member name="P:Amazon.EC2.Model.DiskImageDescriptionType.Checksum"> <summary> Checksum computed for the disk image. </summary> </member> <member name="T:Amazon.EC2.Model.DiskImageDetailType"> <summary> Details about the format of the image. </summary> </member> <member name="M:Amazon.EC2.Model.DiskImageDetailType.WithFormat(System.String)"> <summary> Sets the file format of the disk image. </summary> <param name="format">File format of the disk image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDetailType.IsSetFormat"> <summary> Checks if Format property is set </summary> <returns>true if Format property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDetailType.WithBytes(System.Decimal)"> <summary> Sets the number of bytes in the disk image. </summary> <param name="bytes">Number of bytes in the disk image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDetailType.IsSetBytes"> <summary> Checks if Bytes property is set </summary> <returns>true if Bytes property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDetailType.WithImportManifestUrl(System.String)"> <summary> Sets a presigned URL for the import manifest stored in Amazon S3. </summary> <param name="importManifestUrl">The manifest for the disk image, stored in Amazon S3 and presented here as an Amazon S3 pre-signed URL. For information about creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageDetailType.IsSetImportManifestUrl"> <summary> Checks if ImportManifestUrl property is set </summary> <returns>true if ImportManifestUrl property is set</returns> </member> <member name="P:Amazon.EC2.Model.DiskImageDetailType.Format"> <summary> File format of the disk image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDetailType.Bytes"> <summary> Number of bytes in the disk image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDetailType.ImportManifestUrl"> <summary> A presigned URL for the import manifest stored in Amazon S3. </summary> <remarks> The manifest for the disk image, stored in Amazon S3 and presented here as an Amazon S3 pre-signed URL. For information about creating a pre-signed URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide. </remarks> </member> <member name="T:Amazon.EC2.Model.DiskImageType"> <summary> Details about a disk image. </summary> </member> <member name="M:Amazon.EC2.Model.DiskImageType.WithImage(Amazon.EC2.Model.DiskImageDetailType)"> <summary> Sets details about the format of the image. </summary> <param name="image">Details about the format of the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageType.IsSetImage"> <summary> Checks if Image property is set </summary> <returns>true if Image property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageType.WithDescription(System.String)"> <summary> Sets the description of the disk image. </summary> <param name="description">Optional description of the disk image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageType.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageType.WithVolume(Amazon.EC2.Model.DiskImageVolumeType)"> <summary> Sets details about the size of the image. </summary> <param name="volume">Details about the size of the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageType.IsSetVolume"> <summary> Checks if Volume property is set </summary> <returns>true if Volume property is set</returns> </member> <member name="P:Amazon.EC2.Model.DiskImageType.Image"> <summary> Details about the format of the image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageType.Description"> <summary> Description of the disk image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageType.Volume"> <summary> Details about the size of the image. </summary> </member> <member name="T:Amazon.EC2.Model.DiskImageVolumeDescriptionType"> <summary> Describes disk image volume. </summary> </member> <member name="M:Amazon.EC2.Model.DiskImageVolumeDescriptionType.WithSize(System.Decimal)"> <summary> Sets the size of the volume. </summary> <param name="size">Size of the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageVolumeDescriptionType.IsSetSize"> <summary> Checks if Size property is set </summary> <returns>true if Size property is set</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageVolumeDescriptionType.WithId(System.String)"> <summary> Sets the volume identifier. </summary> <param name="id">Volume identifier.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageVolumeDescriptionType.IsSetId"> <summary> Checks if Id property is set </summary> <returns>true if Id property is set</returns> </member> <member name="P:Amazon.EC2.Model.DiskImageVolumeDescriptionType.Size"> <summary> Size of the volume. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageVolumeDescriptionType.Id"> <summary> Volume identifier. </summary> </member> <member name="T:Amazon.EC2.Model.DiskImageVolumeType"> <summary> Details about the size of the image. </summary> </member> <member name="M:Amazon.EC2.Model.DiskImageVolumeType.WithSize(System.Decimal)"> <summary> Sets the size, in GB (2^30 bytes), of the Amazon EBS volume that will hold the converted image. </summary> <param name="size">The size, in GB (2^30 bytes), of the Amazon EBS volume that will hold the converted image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.DiskImageVolumeType.IsSetSize"> <summary> Checks if Size property is set </summary> <returns>true if Size property is set</returns> </member> <member name="P:Amazon.EC2.Model.DiskImageVolumeType.Size"> <summary> The size, in GB (2^30 bytes), of the Amazon EBS volume that will hold the converted image. </summary> </member> <member name="T:Amazon.EC2.Model.EbsBlockDevice"> <summary> Information about an EBS block device. </summary> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.WithSnapshotId(System.String)"> <summary> Sets the ID of the snapshot. </summary> <param name="snapshotId">The ID of the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.WithVolumeSize(System.Decimal)"> <summary> Sets the size of the volume. </summary> <param name="volumeSize">Size of the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.IsSetVolumeSize"> <summary> Checks if VolumeSize property is set </summary> <returns>true if VolumeSize property is set</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.WithDeleteOnTermination(System.Boolean)"> <summary> Sets whether the EBS block device is deleted on instance termination. </summary> <param name="deleteOnTermination">Whether the EBS block device is deleted on instance termination.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.IsSetDeleteOnTermination"> <summary> Checks if DeleteOnTermination property is set </summary> <returns>true if DeleteOnTermination property is set</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.WithIOPS(System.String)"> <summary> Sets quantity of desired throughput in IOPS. </summary> <param name="iops">Quantity of desired throughput in IOPS</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.IsSetIOPS"> <summary> Checks if IOPS property is set </summary> <returns>True if IOPS property is set</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.WithVolumeType(System.String)"> <summary> Sets the volume type. </summary> <param name="volumeType">Volume Type. Constraints: may be either "io1" or "standard". If VolumeType != "io1", IOPS property cannot be set. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.EbsBlockDevice.IsSetVolumeType"> <summary> Checks if VolumeType property is set </summary> <returns>True if VolumeType property is set</returns> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.SnapshotId"> <summary> The ID of the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.VolumeSize"> <summary> Size of the volume. </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.DeleteOnTermination"> <summary> Whether the EBS block device is deleted on instance termination. </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.IOPS"> <summary> Quantity of desired throughput in IOPS. </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.VolumeType"> <summary> The volume type. Constraints: may be either "io1" or "standard". If VolumeType != "io1", IOPS property cannot be set. </summary> </member> <member name="T:Amazon.EC2.Model.VirtualizationType"> <summary> Constants for the possible virtualization type. <see href="http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-RunInstances.html"/> </summary> </member> <member name="F:Amazon.EC2.Model.VirtualizationType.Hvm"> <summary> HVM (Hardware Virtual Machine) based virtualization is a type of full virtualization enabled through native hardware platform support for virtualization. </summary> </member> <member name="F:Amazon.EC2.Model.VirtualizationType.ParaVirtual"> <summary> PVM (Para-Virtual Machine) based virtualization does not have direct access to the hardware. </summary> </member> <member name="T:Amazon.EC2.Model.PlacementStrategy"> <summary> Constants for the strategy of a placement group. <see href="http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference_query_CreatePlacementGroup.html"/> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceType"> <summary> The instance types possible by EC2. <see href="http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/index.html?ApiReference-query-RunInstances.html"/> </summary> </member> <member name="T: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> </member> <member name="M:Amazon.EC2.Model.EnableVolumeIORequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.EnableVolumeIORequest.WithVolumeId(System.String)"> <summary> Sets the volume on which to turn on IO </summary> <param name="volumeId">The new volume id</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.EnableVolumeIORequest.VolumeId"> <summary> The volume on which to turn on IO </summary> </member> <member name="T:Amazon.EC2.Model.EnableVolumeIOResponse"> <summary> Enable Volume IO response. </summary> </member> <member name="M:Amazon.EC2.Model.EnableVolumeIOResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.EnableVolumeIOResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.EnableVolumeIOResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.EnableVolumeIOResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.EnableVGWRoutePropagationRequest"> <summary> Enables a virtual private gateway (VGW) to propagate routes to the routing tables of an Amazon VPC. </summary> </member> <member name="M:Amazon.EC2.Model.EnableVGWRoutePropagationRequest.WithRouteTableId(System.String)"> <summary> Sets the ID of the routing table. </summary> <param name="routeTableId">Routing table id</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.EnableVGWRoutePropagationRequest.IsSetRouteTableId"> <summary> Checks is the RouteTableId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.EnableVGWRoutePropagationRequest.WithGatewayId(System.String)"> <summary> Sets the ID of the Virtual Private Gateway. </summary> <param name="gatewayId">Gateway Id</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.EnableVGWRoutePropagationRequest.IsSetGatewayId"> <summary> Checks if the GatewayId property is set </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.EnableVGWRoutePropagationRequest.RouteTableId"> <summary> ID of the routing table. </summary> </member> <member name="P:Amazon.EC2.Model.EnableVGWRoutePropagationRequest.GatewayId"> <summary> ID of the Virtual Private Gateway. </summary> </member> <member name="T:Amazon.EC2.Model.EnableVGWRoutePropagationResponse"> <summary> Enable Virtual Gateway (VGW) Route Propagation Response </summary> </member> <member name="M:Amazon.EC2.Model.EnableVGWRoutePropagationResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.EnableVGWRoutePropagationResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.EnableVGWRoutePropagationResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.EnableVGWRoutePropagationResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.Error"> <summary> Error </summary> </member> <member name="M:Amazon.EC2.Model.Error.WithType(System.String)"> <summary> Sets the type of error </summary> <param name="type">Type of error</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Error.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.Error.WithCode(System.String)"> <summary> Sets the error code </summary> <param name="code">Error code</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Error.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.Error.WithMessage(System.String)"> <summary> Sets the error message </summary> <param name="message">Error message</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Error.IsSetMessage"> <summary> Checks if Message property is set </summary> <returns>true if Message property is set</returns> </member> <member name="M:Amazon.EC2.Model.Error.WithDetail(System.Object)"> <summary> Sets the details of the error </summary> <param name="detail">Details</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Error.IsSetDetail"> <summary> Checks if Detail property is set </summary> <returns>true if Detail property is set</returns> </member> <member name="P:Amazon.EC2.Model.Error.Type"> <summary> Type of error </summary> </member> <member name="P:Amazon.EC2.Model.Error.Code"> <summary> Error code </summary> </member> <member name="P:Amazon.EC2.Model.Error.Message"> <summary> Error message </summary> </member> <member name="P:Amazon.EC2.Model.Error.Detail"> <summary> Details of the error </summary> </member> <member name="T:Amazon.EC2.Model.ErrorResponse"> <summary> Error Response </summary> </member> <member name="M:Amazon.EC2.Model.ErrorResponse.IsSetError"> <summary> Checks if Error property is set </summary> <returns>true if Error property is set</returns> </member> <member name="M:Amazon.EC2.Model.ErrorResponse.IsSetRequestId"> <summary> Checks if RequestId property is set </summary> <returns>true if RequestId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ErrorResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ErrorResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ErrorResponse.Error"> <summary> One or more errors </summary> </member> <member name="P:Amazon.EC2.Model.ErrorResponse.RequestId"> <summary> Request Id </summary> </member> <member name="T:Amazon.EC2.Model.ExportTaskType"> <summary> Details of an ExportVM task. </summary> </member> <member name="M:Amazon.EC2.Model.ExportTaskType.IsSetExportTaskId"> <summary> Checks if the ExportTaskId property is set. </summary> <returns>True if the ExportTaskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportTaskType.IsSetDescription"> <summary> Checks if the Description property is set. </summary> <returns>True if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportTaskType.IsSetState"> <summary> Checks if the State property is set. </summary> <returns>True if the State property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportTaskType.IsSetStatusMessage"> <summary> Checks if the StatusMessage property is set. </summary> <returns>True if the StatusMessage property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportTaskType.IsSetInstanceExportTask"> <summary> Checks if the InstanceExportTask property is set. </summary> <returns>True if the InstanceExportTask property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportTaskType.IsSetExportToS3Task"> <summary> Checks if the ExportToS3Task property is set. </summary> <returns>True if the ExportToS3Task property is set</returns> </member> <member name="P:Amazon.EC2.Model.ExportTaskType.ExportTaskId"> <summary> The ID of the export task. </summary> </member> <member name="P:Amazon.EC2.Model.ExportTaskType.Description"> <summary> The description of the resource being exported. </summary> </member> <member name="P:Amazon.EC2.Model.ExportTaskType.State"> <summary> The state of the conversion task. </summary> </member> <member name="P:Amazon.EC2.Model.ExportTaskType.StatusMessage"> <summary> The status message related to the export task. </summary> </member> <member name="P:Amazon.EC2.Model.ExportTaskType.InstanceExportTask"> <summary> Information about the instance being exported. </summary> </member> <member name="P:Amazon.EC2.Model.ExportTaskType.ExportToS3Task"> <summary> Information about the destination Amazon S3 bucket. </summary> </member> <member name="T:Amazon.EC2.Model.ExportToS3TaskType"> <summary> Information about the destination Amazon S3 bucket for a VM export task. </summary> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.WithDiskImageFormat(System.String)"> <summary> Sets the format for the exported image. Default: vmdk if TargetEnvironment = vmware, otherwise vhd </summary> <param name="diskImageFormat">Disk image format; valid Values: vmdk | vhd</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.IsSetDiskImageFormat"> <summary> Checks if the DiskImageFormat property is set. </summary> <returns>True if the DiskImageFormat property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.WithContainerFormat(System.String)"> <summary> Sets the container format used to combine disk images with metadata (such as OVF). </summary> <param name="containerFormat">Container format; valid values: ova</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.IsSetContainerFormat"> <summary> Checks if the ContainerFormat property is set </summary> <returns>True if the ContainerFormat property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.WithS3Bucket(System.String)"> <summary> Sets the Amazon S3 bucket for the destination image. The bucket must exist and grant write permissions to AWS account vm-import-export@amazon.com. </summary> <param name="s3Bucket">S3 bucket name</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.IsSetS3Bucket"> <summary> Checks if the S3Bucket property is set. </summary> <returns>True if the S3Bucket property is set</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.WithS3Prefix(System.String)"> <summary> Sets the key prefix to use when writing the image to S3 for a CreateInstanceExportTask operation. </summary> <param name="s3Prefix">Key prefix; full key will be set as S3Prefix + exportTaskId + ‘.’ +diskImageFormat.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.IsSetS3Prefix"> <summary> Checks if the S3Prefix property is set. </summary> <returns>True if the S3Prefix property is set.</returns> </member> <member name="M:Amazon.EC2.Model.ExportToS3TaskType.IsSetS3Key"> <summary> Checks if the S3Key property is set. </summary> <returns>True if the S3Key property is set.</returns> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskType.DiskImageFormat"> <summary> The format for the exported image. </summary> <remarks>Valid Values: vmdk | vhd</remarks> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskType.ContainerFormat"> <summary> The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image will be exported. Default: ova if TargetEnvironment = vmare, otherwise blank. </summary> <remarks>Valid Values: ova</remarks> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskType.S3Bucket"> <summary> The Amazon S3 bucket for the destination image. </summary> <remarks>The bucket must exist and grant write permissions to AWS account vm-import-export@amazon.com.</remarks> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskType.S3Prefix"> <summary> The key prefix used when writing the image to a single object in the bucket. </summary> <remarks>This property is used when the ExportToS3TaskType instance is used as input to the CreateInstanceExportTask operation. The resulting S3 object key will be set as 'S3Prefix + exportTaskId + ‘.’ +diskImageFormat'. </remarks> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskType.S3Key"> <summary> The full S3 key that was used when writing the exported instance to S3. </summary> <remarks> This property is only set on return from the CreateInstanceExportTask operation. The S3 object key is in the form 'S3Prefix + exportTaskId + ‘.’ +diskImageFormat'. </remarks> </member> <member name="T:Amazon.EC2.Model.Filter"> <summary> A filter used to limit results when describing tags. Multiple values can be specified per filter. A tag must match at least one of the specified values for it to be returned from an operation. Wildcards can be included in filter values; * specifies that zero or more characters must match, and ? specifies that exactly one character must match.Use a backslash to escape special characters. For example, a filter value of \*amazon\?\\ specifies the literal string *amazon?\. </summary> </member> <member name="M:Amazon.EC2.Model.Filter.WithName(System.String)"> <summary> Sets the name of the filter. </summary> <param name="name">Specifies the name of the filter.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Filter.IsSetName"> <summary> Checks if Name property is set </summary> <returns>true if Name property is set</returns> </member> <member name="M:Amazon.EC2.Model.Filter.WithValue(System.String[])"> <summary> Sets values for the filter. </summary> <param name="list">Contains one or more values for the filter.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Filter.IsSetValue"> <summary> Checks if Value property is set </summary> <returns>true if Value property is set</returns> </member> <member name="P:Amazon.EC2.Model.Filter.Name"> <summary> The name of the filter. </summary> </member> <member name="P:Amazon.EC2.Model.Filter.Value"> <summary> One or more values for the filter. </summary> </member> <member name="T:Amazon.EC2.Model.GetConsoleOutputRequest"> <summary> Retrieves console output for the specified instance. </summary> <remarks> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which will be available for at least one hour after the most recent post. </remarks> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance for which you want console output. </summary> <param name="instanceId">ID of the instance for which you want console output.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputRequest.InstanceId"> <summary> ID of the instance for which you want console output. </summary> </member> <member name="T:Amazon.EC2.Model.GetConsoleOutputResponse"> <summary> Get Console Output Response </summary> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputResponse.IsSetGetConsoleOutputResult"> <summary> Checks if GetConsoleOutputResult property is set </summary> <returns>true if GetConsoleOutputResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputResponse.GetConsoleOutputResult"> <summary> Gets and sets the GetConsoleOutputResult property. Get Console Output Result </summary> </member> <member name="T:Amazon.EC2.Model.GetConsoleOutputResult"> <summary> Get Console Output Result </summary> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputResult.IsSetConsoleOutput"> <summary> Checks if ConsoleOutput property is set </summary> <returns>true if ConsoleOutput property is set</returns> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputResult.ConsoleOutput"> <summary> Gets and sets the ConsoleOutput property. Console output </summary> </member> <member name="T:Amazon.EC2.Model.GetPasswordDataRequest"> <summary> Retrieves the encrypted administrator password for the instances running Windows. </summary> <remarks> The Windows password is only generated the first time an AMI is launched. It is not generated for rebundled AMIs or after the password is changed on an instance. The password is encrypted using the key pair that you provided. </remarks> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance for which to get the password. </summary> <param name="instanceId">The ID of the instance for which to get the password.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataRequest.InstanceId"> <summary> The ID of the instance for which to get the password. </summary> </member> <member name="T:Amazon.EC2.Model.GetPasswordDataResponse"> <summary> Get Password Data Response </summary> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResponse.IsSetGetPasswordDataResult"> <summary> Checks if GetPasswordDataResult property is set </summary> <returns>true if GetPasswordDataResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataResponse.GetPasswordDataResult"> <summary> Gets and sets the GetPasswordDataResult property. Get Password Data Result </summary> </member> <member name="T:Amazon.EC2.Model.GetPasswordDataResult"> <summary> Get Password Data Result </summary> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResult.IsSetPasswordData"> <summary> Checks if PasswordData property is set </summary> <returns>true if PasswordData property is set</returns> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataResult.GetDecryptedPassword(System.String)"> <summary> Gets the decrypted password using the RSA private key which can be found in the PEM file for the key pair. </summary> <param name="rsaPrivateKey">The RSA private key from the PEM file</param> <returns>The decrypted password</returns> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataResult.PasswordData"> <summary> Gets and sets the PasswordData property. Password data </summary> </member> <member name="T:Amazon.EC2.Model.IAMInstanceProfile"> <summary> Description of an Amazon EC2 Instance Profile. </summary> </member> <member name="M:Amazon.EC2.Model.IAMInstanceProfile.WithArn(System.String)"> <summary> Sets the ARN of the instance profile. </summary> <param name="arn">IAM Instance Profile to use if a profile should be attached to the new Amazon EC2 instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IAMInstanceProfile.IsSetArn"> <summary> Checks if Arn property is set </summary> <returns>true if Arn property is set</returns> </member> <member name="M:Amazon.EC2.Model.IAMInstanceProfile.WithId(System.String)"> <summary> Sets the Id of the instance profile. </summary> <param name="id">IAM Instance Profile to use if a profile should be attached to the new Amazon EC2 instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IAMInstanceProfile.IsSetId"> <summary> Checks if Arn property is set </summary> <returns>true if Arn property is set</returns> </member> <member name="P:Amazon.EC2.Model.IAMInstanceProfile.Arn"> <summary> The ARN of the instance profile. </summary> </member> <member name="P:Amazon.EC2.Model.IAMInstanceProfile.Id"> <summary> The Id of the instance profile. </summary> </member> <member name="T:Amazon.EC2.Model.Icmp"> <summary> ICMP description. </summary> </member> <member name="M:Amazon.EC2.Model.Icmp.WithCode(System.Decimal)"> <summary> Sets the ICMP code. </summary> <param name="code">The ICMP code. A value of -1 is a wildcard meaning all codes.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Icmp.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.Icmp.WithType(System.Decimal)"> <summary> Sets the ICMP type. </summary> <param name="type">The ICMP type. A value of -1 is a wildcard meaning all types.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Icmp.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="P:Amazon.EC2.Model.Icmp.Code"> <summary> The ICMP code. A value of -1 is a wildcard meaning all codes. </summary> </member> <member name="P:Amazon.EC2.Model.Icmp.Type"> <summary> The ICMP type. A value of -1 is a wildcard meaning all types. </summary> </member> <member name="T:Amazon.EC2.Model.Image"> <summary> Image (AMI) description. </summary> </member> <member name="M:Amazon.EC2.Model.Image.WithImageId(System.String)"> <summary> Sets the ID of the AMI. </summary> <param name="imageId">The ID of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithImageLocation(System.String)"> <summary> Sets the location of the AMI. </summary> <param name="imageLocation">The location of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetImageLocation"> <summary> Checks if ImageLocation property is set </summary> <returns>true if ImageLocation property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithImageState(System.String)"> <summary> Sets current state of the AMI. </summary> <param name="imageState">Current state of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetImageState"> <summary> Checks if ImageState property is set </summary> <returns>true if ImageState property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithOwnerId(System.String)"> <summary> Sets the AWS Access Key ID of the image owner. </summary> <param name="ownerId">AWS Access Key ID of the image owner.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetOwnerId"> <summary> Checks if OwnerId property is set </summary> <returns>true if OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithVisibility(System.String)"> <summary> Sets the image visibility. </summary> <param name="visibility">Visibility - public or private</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetVisibility"> <summary> Checks if Visibility property is set </summary> <returns>true if Visibility property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithProductCode(System.String[])"> <summary> Sets the product codes of the AMI </summary> <param name="list">Product codes of the AMI</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetProductCode"> <summary> Checks if ProductCode property is set </summary> <returns>true if ProductCode property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithProductCodes(Amazon.EC2.Model.ProductCode[])"> <summary> Sets the product codes attached to this instance. </summary> <param name="list">Product codes attached to this instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetProductCodes"> <summary> Checks if ProductCodes property is set </summary> <returns>true if ProductCodes property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithArchitecture(System.String)"> <summary> Sets the architecture of the image. </summary> <param name="architecture">The architecture of the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetArchitecture"> <summary> Checks if Architecture property is set </summary> <returns>true if Architecture property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithImageType(System.String)"> <summary> Sets the image type. </summary> <param name="imageType">The type of image</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetImageType"> <summary> Checks if ImageType property is set </summary> <returns>true if ImageType property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithKernelId(System.String)"> <summary> Sets the kernel associated with the image. </summary> <param name="kernelId">The kernel associated with the image, if any. Only applicable for machine images.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetKernelId"> <summary> Checks if KernelId property is set </summary> <returns>true if KernelId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithRamdiskId(System.String)"> <summary> Sets the RAM disk associated with the image. </summary> <param name="ramdiskId">The RAM disk associated with the image, if any. Only applicable for machine images.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetRamdiskId"> <summary> Checks if RamdiskId property is set </summary> <returns>true if RamdiskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithPlatform(System.String)"> <summary> Sets the operating platform of the instance. </summary> <param name="platform">The operating platform of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetPlatform"> <summary> Checks if Platform property is set </summary> <returns>true if Platform property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithStateReason(Amazon.EC2.Model.StateReason)"> <summary> Ses the reason for the state change. </summary> <param name="stateReason">The reason for the state change.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetStateReason"> <summary> Checks if StateReason property is set </summary> <returns>true if StateReason property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithImageOwnerAlias(System.String)"> <summary> Sets the AWS account alias (e.g., "amazon") or AWS account ID that owns the AMI. </summary> <param name="imageOwnerAlias">The AWS account alias (e.g., "amazon") or AWS account ID that owns the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetImageOwnerAlias"> <summary> Checks if ImageOwnerAlias property is set </summary> <returns>true if ImageOwnerAlias property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithName(System.String)"> <summary> Sets the name of the AMI. </summary> <param name="name">The name of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetName"> <summary> Checks if Name property is set </summary> <returns>true if Name property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithDescription(System.String)"> <summary> Sets the description of the AMI. </summary> <param name="description">The description of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithRootDeviceType(System.String)"> <summary> Sets the root device type used by the AMI. </summary> <param name="rootDeviceType">The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetRootDeviceType"> <summary> Checks if RootDeviceType property is set </summary> <returns>true if RootDeviceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithRootDeviceName(System.String)"> <summary> Sets the root device name (e.g., /dev/sda1). </summary> <param name="rootDeviceName">The root device name (e.g., /dev/sda1).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetRootDeviceName"> <summary> Checks if RootDeviceName property is set </summary> <returns>true if RootDeviceName property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithBlockDeviceMapping(Amazon.EC2.Model.BlockDeviceMapping[])"> <summary> Sets specifications of how block devices are exposed to the instance. </summary> <param name="list">Specifies how block devices are exposed to the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithVirtualizationType(System.String)"> <summary> Sets whether the Amazon EC2 instance is a hardware virtual machine (HVM) or a para-virtual machine (PVM). </summary> <param name="virtualizationType">Specifies whether the Amazon EC2 instance is a hardware virtual machine (HVM) or a para-virtual machine (PVM).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetVirtualizationType"> <summary> Checks if VirtualizationType property is set </summary> <returns>true if VirtualizationType property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the list of tags for the Image. </summary> <param name="list">A list of tags for the Image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.Image.WithHypervisor(System.String)"> <summary> Sets the image hypervisor type. </summary> <param name="hypervisor">Hypervisor property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Image.IsSetHypervisor"> <summary> Checks if Hypervisor property is set </summary> <returns>true if Hypervisor property is set</returns> </member> <member name="P:Amazon.EC2.Model.Image.ImageId"> <summary> The ID of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageLocation"> <summary> The location of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageState"> <summary> Current state of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Image.OwnerId"> <summary> AWS Access Key ID of the image owner. </summary> </member> <member name="P:Amazon.EC2.Model.Image.Visibility"> <summary> Image visibility. Valid values: public | private </summary> </member> <member name="P:Amazon.EC2.Model.Image.ProductCode"> <summary> Product codes of the AMI </summary> </member> <member name="P:Amazon.EC2.Model.Image.ProductCodes"> <summary> Product codes attached to this instance. </summary> </member> <member name="P:Amazon.EC2.Model.Image.Architecture"> <summary> The architecture of the image. </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageType"> <summary> The image type. </summary> </member> <member name="P:Amazon.EC2.Model.Image.KernelId"> <summary> The kernel associated with the image, if any. Only applicable for machine images. </summary> </member> <member name="P:Amazon.EC2.Model.Image.RamdiskId"> <summary> The RAM disk associated with the image, if any. Only applicable for machine images. </summary> </member> <member name="P:Amazon.EC2.Model.Image.Platform"> <summary> The operating platform of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.Image.StateReason"> <summary> The reason for the state change. </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageOwnerAlias"> <summary> The AWS account alias (e.g., "amazon") or AWS account ID that owns the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Image.Name"> <summary> The name of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Image.Description"> <summary> The description of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Image.RootDeviceType"> <summary> The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device. </summary> </member> <member name="P:Amazon.EC2.Model.Image.RootDeviceName"> <summary> The root device name (e.g., /dev/sda1). </summary> </member> <member name="P:Amazon.EC2.Model.Image.BlockDeviceMapping"> <summary> One or more specifications of how block devices are exposed to the instance. </summary> </member> <member name="P:Amazon.EC2.Model.Image.VirtualizationType"> <summary> Specifies whether the Amazon EC2 instance is a hardware virtual machine (HVM) or a para-virtual machine (PVM). </summary> </member> <member name="P:Amazon.EC2.Model.Image.Tag"> <summary> A list of tags for the Image. </summary> </member> <member name="P:Amazon.EC2.Model.Image.Hypervisor"> <summary> The image hypervisor type. </summary> </member> <member name="T:Amazon.EC2.Model.ImageAttribute"> <summary> Image Attribute </summary> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithImageId(System.String)"> <summary> Sets the ID of the AMI. </summary> <param name="imageId">The ID of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithLaunchPermission(Amazon.EC2.Model.LaunchPermission[])"> <summary> Sets the launch permissions. </summary> <param name="list">Launch permissions.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetLaunchPermission"> <summary> Checks if LaunchPermission property is set </summary> <returns>true if LaunchPermission property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithProductCode(System.String[])"> <summary> Sets the image product codes. </summary> <param name="list">Product codes.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetProductCode"> <summary> Checks if ProductCode property is set </summary> <returns>true if ProductCode property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithProductCodes(Amazon.EC2.Model.ProductCode[])"> <summary> Sets the product codes attached to this instance. </summary> <param name="list">Product codes attached to this instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetProductCodes"> <summary> Checks if ProductCodes property is set </summary> <returns>true if ProductCodes property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithKernelId(System.String)"> <summary> Sets the kernel ID. </summary> <param name="kernelId">Kernel ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetKernelId"> <summary> Checks if KernelId property is set </summary> <returns>true if KernelId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithRamdiskId(System.String)"> <summary> Sets the RAM disk ID. </summary> <param name="ramdiskId">RAM disk ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetRamdiskId"> <summary> Checks if RamdiskId property is set </summary> <returns>true if RamdiskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithDescription(System.String)"> <summary> Sets the image description. </summary> <param name="description">Description property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.WithBlockDeviceMapping(Amazon.EC2.Model.BlockDeviceMapping[])"> <summary> Sets list of BlockDeviceMappings. </summary> <param name="list">BlockDeviceMapping property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImageAttribute.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.ImageId"> <summary> The ID of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.LaunchPermission"> <summary> Launch permissions. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.ProductCode"> <summary> Image product codes. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.ProductCodes"> <summary> Product codes attached to this instance. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.KernelId"> <summary> Kernel ID. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.RamdiskId"> <summary> RAM disk ID. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.Description"> <summary> Image description. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.BlockDeviceMapping"> <summary> List of BlockDeviceMappings. </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType"> <summary> Additional launch instance information. </summary> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithArchitecture(System.String)"> <summary> Sets the architecture of the instance. </summary> <param name="architecture">Architecture of the instance. Valid Values: i386 | x86_64</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetArchitecture"> <summary> Checks if Architecture property is set </summary> <returns>true if Architecture property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithSecurityGroup(System.String[])"> <summary> Sets security group names. </summary> <param name="list">One or more security group names.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetSecurityGroup"> <summary> Checks if SecurityGroup property is set </summary> <returns>true if SecurityGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithSecurityGroupId(System.String[])"> <summary> Sets the security group IDs. </summary> <param name="list">One or more security group IDs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetSecurityGroupId"> <summary> Checks if SecurityGroupId property is set </summary> <returns>true if SecurityGroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithUserData(System.String)"> <summary> Sets the user data to be made available to the instance. </summary> <param name="userData">User data to be made available to the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetUserData"> <summary> Checks if UserData property is set </summary> <returns>true if UserData property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithInstanceType(System.String)"> <summary> Sets the instance type. </summary> <param name="instanceType">Specifies the instance type. Valid Values: m1.small | m1.medium | m1.large | m1.xlarge | c1.medium | c1.xlarge | m2.2xlarge | m2.4xlarge Default: m1.small</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithPlacement(Amazon.EC2.Model.Placement)"> <summary> Sets the placement constraints. </summary> <param name="placement">Specifies the placement constraints.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetPlacement"> <summary> Checks if Placement property is set </summary> <returns>true if Placement property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithMonitoring(Amazon.EC2.Model.MonitoringSpecification)"> <summary> Sets the instance monitoring configuration. </summary> <param name="monitoring">Enables monitoring for the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetMonitoring"> <summary> Checks if Monitoring property is set </summary> <returns>true if Monitoring property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet you want to launch the instance into. </summary> <param name="subnetId">If you're using Amazon Virtual Private Cloud, this specifies the ID of the subnet you want to launch the instance into.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithInstanceInitiatedShutdownBehavior(System.String)"> <summary> Sets whether the instance stops or terminates on instance-initiated shutdown. </summary> <param name="instanceInitiatedShutdownBehavior">Determines whether the instance stops or terminates on instance-initiated shutdown. Valid Values: stop | terminate</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetInstanceInitiatedShutdownBehavior"> <summary> Checks if InstanceInitiatedShutdownBehavior property is set </summary> <returns>true if InstanceInitiatedShutdownBehavior property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.WithPrivateIpAddress(System.String)"> <summary> Sets the private IP address for the instance. </summary> <param name="privateIpAddress">If you're using Amazon Virtual Private Cloud, you can optionally use this parameter to assign the instance a specific available IP address from the subnet (e.g., 10.0.0.25).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.IsSetPrivateIpAddress"> <summary> Checks if PrivateIpAddress property is set </summary> <returns>true if PrivateIpAddress property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.Architecture"> <summary> Architecture of the instance. Valid Values: i386 | x86_64 </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.SecurityGroup"> <summary> One or more security group names. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.SecurityGroupId"> <summary> One or more security group IDs. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.UserData"> <summary> User data to be made available to the instance. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.InstanceType"> <summary> The instance type. Valid Values: m1.small | m1.medium | m1.large | m1.xlarge | c1.medium | c1.xlarge | m2.2xlarge | m2.4xlarge Default: m1.small </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.Placement"> <summary> The placement constraints. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.Monitoring"> <summary> Instance monitoring configuration. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.SubnetId"> <summary> The ID of the subnet you want to launch the instance into. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.InstanceInitiatedShutdownBehavior"> <summary> Whether the instance stops or terminates on instance-initiated shutdown. Valid Values: stop | terminate </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecificationType.PrivateIpAddress"> <summary> Private IP address for the instance. </summary> <remarks> If you're using Amazon Virtual Private Cloud, you can optionally assign the instance a specific available IP address from the subnet (e.g., 10.0.0.25). </remarks> </member> <member name="T:Amazon.EC2.Model.ImportInstanceRequest"> <summary> Container for the parameters to the ImportInstance operation. <para>Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.</para> </summary> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.WithDescription(System.String)"> <summary> Sets the description of the instance being imported </summary> <param name="description">Description of the instance being imported</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.WithLaunchSpecification(Amazon.EC2.Model.ImportInstanceLaunchSpecificationType)"> <summary> Sets additional launch instance information. </summary> <param name="launchSpecification">Specifies additional launch instance information.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.IsSetLaunchSpecification"> <summary> Checks if LaunchSpecification property is set </summary> <returns>true if LaunchSpecification property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.WithDiskImage(Amazon.EC2.Model.DiskImageType[])"> <summary> Sets details about the image. </summary> <param name="list">Details about the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.IsSetDiskImage"> <summary> Checks if DiskImage property is set </summary> <returns>true if DiskImage property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.WithPlatform(System.String)"> <summary> Sets the EC2 instance operating system. </summary> <param name="platform">The EC2 instance operating system. Valid Value: Windows</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceRequest.IsSetPlatform"> <summary> Checks if Platform property is set </summary> <returns>true if Platform property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.Description"> <summary> Description of the instance being imported </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.LaunchSpecification"> <summary> Additional launch instance information. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.DiskImage"> <summary> Details about the image. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.Platform"> <summary> The EC2 instance operating system. Valid Value: Windows </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceResponse"> <summary> The Response for the ImportInstance operation. </summary> </member> <member name="M:Amazon.EC2.Model.ImportInstanceResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceResponse.IsSetImportInstanceResult"> <summary> Checks if ImportInstanceResult property is set </summary> <returns>true if ImportInstanceResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ImportInstanceResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceResponse.ImportInstanceResult"> <summary> Gets and sets the ImportInstanceResult property. Import Instance Result </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceResult"> <summary> Import Instance Result </summary> </member> <member name="M:Amazon.EC2.Model.ImportInstanceResult.IsSetConversionTask"> <summary> Checks if ConversionTask property is set </summary> <returns>true if ConversionTask property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ImportInstanceResult.ConversionTask"> <summary> Gets and sets the ConversionTask property. Information about the import instance task. </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceTaskDetailsType"> <summary> Details for an import instance task. </summary> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.WithVolumes(Amazon.EC2.Model.ImportInstanceVolumeDetailItemType[])"> <summary> Sets the list of instance volumes for import. </summary> <param name="list">A list of instance volumes for import. Each volume's information is wrapped in an item element.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.IsSetVolumes"> <summary> Checks if Volumes property is set </summary> <returns>true if Volumes property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.WithInstanceId(System.String)"> <summary> Sets the ID of the resulting instance in Amazon EC2. </summary> <param name="instanceId">The ID of the resulting instance in Amazon EC2.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.WithPlatform(System.String)"> <summary> Sets the instance operating system. </summary> <param name="platform">Instance operating system.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.IsSetPlatform"> <summary> Checks if Platform property is set </summary> <returns>true if Platform property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.WithDescription(System.String)"> <summary> Sets the description of the instance. </summary> <param name="description">Optional description of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceTaskDetailsType.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetailsType.Volumes"> <summary> A list of instance volumes for import. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetailsType.InstanceId"> <summary> The ID of the resulting instance in Amazon EC2. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetailsType.Platform"> <summary> Instance operating system. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetailsType.Description"> <summary> Description of the instance. </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType"> <summary> Details for an import instance volume item. </summary> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.WithBytesConverted(System.Decimal)"> <summary> Sets the number of bytes converted so far. </summary> <param name="bytesConverted">Number of bytes converted so far.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.IsSetBytesConverted"> <summary> Checks if BytesConverted property is set </summary> <returns>true if BytesConverted property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone where the resulting instance will reside. </summary> <param name="availabilityZone">The Availability Zone where the resulting instance will reside.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.WithImage(Amazon.EC2.Model.DiskImageDescriptionType)"> <summary> Sets the information about the image. </summary> <param name="image">Information about the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.IsSetImage"> <summary> Checks if Image property is set </summary> <returns>true if Image property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.WithDescription(System.String)"> <summary> Sets the description. </summary> <param name="description">Description you provided when starting the import instance task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.WithVolume(Amazon.EC2.Model.DiskImageVolumeDescriptionType)"> <summary> Sets the information about the volume. </summary> <param name="volume">Information about the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.IsSetVolume"> <summary> Checks if Volume property is set </summary> <returns>true if Volume property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.WithStatus(System.String)"> <summary> Sets the status of the import of this particular disk image. </summary> <param name="status">Status of the import of this particular disk image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.WithStatusMessage(System.String)"> <summary> Sets the status information or errors related to the disk image. </summary> <param name="statusMessage">Status information or errors related to the disk image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.IsSetStatusMessage"> <summary> Checks if StatusMessage property is set </summary> <returns>true if StatusMessage property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.BytesConverted"> <summary> Number of bytes converted so far. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.AvailabilityZone"> <summary> The Availability Zone where the resulting instance will reside. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.Image"> <summary> Information about the image. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.Description"> <summary> Description provided when starting the import instance task. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.Volume"> <summary> Information about the volume. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.Status"> <summary> Status of the import of this particular disk image. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItemType.StatusMessage"> <summary> Status information or errors related to the disk image. </summary> </member> <member name="T:Amazon.EC2.Model.ImportKeyPairRequest"> <summary> Imports the public key from an RSA key pair created with a third-party tool. </summary> <remarks> This operation differs from CreateKeyPair as the private key is never transferred between the caller and AWS servers. RSA key pairs are easily created on Microsoft Windows and Linux OS systems using the ssh-keygen command line tool provided with the standard OpenSSH installation. Standard library support for RSA key pair creation is also available for Java, Ruby, Python, and many other programming languages. The following formats are supported: - OpenSSH public key format, - Base64 encoded DER format. - SSH public key file format as specified in RFC4716. </remarks> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairRequest.WithKeyName(System.String)"> <summary> Sets the unique name for the key pair. </summary> <param name="keyName">The unique name for the key pair.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairRequest.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairRequest.WithPublicKeyMaterial(System.String)"> <summary> Sets the public key. </summary> <param name="publicKeyMaterial">The public key. This key must be base64 encoded before calling this operation.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairRequest.IsSetPublicKeyMaterial"> <summary> Checks if PublicKeyMaterial property is set </summary> <returns>true if PublicKeyMaterial property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairRequest.KeyName"> <summary> The unique name for the key pair. </summary> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairRequest.PublicKeyMaterial"> <summary> The public key. The key must be base64 encoded. </summary> </member> <member name="T:Amazon.EC2.Model.ImportKeyPairResponse"> <summary> The Response for the ImportKeyPair operation. </summary> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResponse.IsSetImportKeyPairResult"> <summary> Checks if ImportKeyPairResult property is set </summary> <returns>true if ImportKeyPairResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairResponse.ImportKeyPairResult"> <summary> Gets and sets the ImportKeyPairResult property. ImportKeyPair Result </summary> </member> <member name="T:Amazon.EC2.Model.ImportKeyPairResult"> <summary> ImportKeyPair Result </summary> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResult.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResult.IsSetKeyFingerprint"> <summary> Checks if KeyFingerprint property is set </summary> <returns>true if KeyFingerprint property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairResult.KeyName"> <summary> Gets and sets the KeyName property. The specified unique key pair name. </summary> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairResult.KeyFingerprint"> <summary> Gets and sets the KeyFingerprint property. The MD5 public key fingerprint as specified in section 4 of RFC4716. </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeRequest"> <summary> Container for the parameters to the ImportVolume operation. <para>Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume 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> .</para> </summary> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone where the resulting Amazon EBS volume will reside. </summary> <param name="availabilityZone">Availability Zone where the resulting Amazon EBS volume will reside.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.WithImage(Amazon.EC2.Model.DiskImageDetailType)"> <summary> Sets the details about the image. </summary> <param name="image">Details about the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.IsSetImage"> <summary> Checks if Image property is set </summary> <returns>true if Image property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.WithDescription(System.String)"> <summary> Sets the description of the volume being imported. </summary> <param name="description">Optional description of the volume being imported.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.WithVolume(Amazon.EC2.Model.DiskImageVolumeType)"> <summary> Sets details about the volume. </summary> <param name="volume">Details about the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeRequest.IsSetVolume"> <summary> Checks if Volume property is set </summary> <returns>true if Volume property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.AvailabilityZone"> <summary> Availability Zone where the resulting Amazon EBS volume will reside. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.Image"> <summary> Details about the image. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.Description"> <summary> Description of the volume being imported. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.Volume"> <summary> Details about the volume. </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeResponse"> <summary> The Response for the ImportVolume operation. </summary> </member> <member name="M:Amazon.EC2.Model.ImportVolumeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeResponse.IsSetImportVolumeResult"> <summary> Checks if ImportVolumeResult property is set </summary> <returns>true if ImportVolumeResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ImportVolumeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeResponse.ImportVolumeResult"> <summary> Gets and sets the ImportVolumeResult property. Import Volume Result </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeResult"> <summary> Import Volume Result </summary> </member> <member name="M:Amazon.EC2.Model.ImportVolumeResult.IsSetConversionTask"> <summary> Checks if ConversionTask property is set </summary> <returns>true if ConversionTask property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ImportVolumeResult.ConversionTask"> <summary> Gets and sets the ConversionTask property. Information about the import instance task. </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeTaskDetailsType"> <summary> Details for an import volume task. </summary> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.WithBytesConverted(System.Decimal)"> <summary> Sets the number of bytes converted so far. </summary> <param name="bytesConverted">Number of bytes converted so far.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.IsSetBytesConverted"> <summary> Checks if BytesConverted property is set </summary> <returns>true if BytesConverted property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone where the resulting volume will reside. </summary> <param name="availabilityZone">The Availability Zone where the resulting volume will reside.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.WithDescription(System.String)"> <summary> Sets the task description. </summary> <param name="description">Description you provided when starting the import volume task.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.WithImage(Amazon.EC2.Model.DiskImageDescriptionType)"> <summary> Sets the information about the image. </summary> <param name="image">Information about the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.IsSetImage"> <summary> Checks if Image property is set </summary> <returns>true if Image property is set</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.WithVolume(Amazon.EC2.Model.DiskImageVolumeDescriptionType)"> <summary> Sets the information about the volume. </summary> <param name="volume">Information about the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ImportVolumeTaskDetailsType.IsSetVolume"> <summary> Checks if Volume property is set </summary> <returns>true if Volume property is set</returns> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetailsType.BytesConverted"> <summary> Number of bytes converted so far. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetailsType.AvailabilityZone"> <summary> The Availability Zone where the resulting volume will reside. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetailsType.Description"> <summary> Task description. This description is one you provided when starting the import volume task. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetailsType.Image"> <summary> Information about the image. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetailsType.Volume"> <summary> Information about the volume. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceAttribute"> <summary> A list of instance attributes. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithInstanceId(System.String)"> <summary> Set the ID of the instance. </summary> <param name="instanceId">The ID of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithInstanceType(System.String)"> <summary> Sets the instance type. </summary> <param name="instanceType">The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and so on).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithKernelId(System.String)"> <summary> Sets the kernel ID. </summary> <param name="kernelId">The kernel ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetKernelId"> <summary> Checks if KernelId property is set </summary> <returns>true if KernelId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithRamdiskId(System.String)"> <summary> Sets the RAM disk ID. </summary> <param name="ramdiskId">The RAM disk ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetRamdiskId"> <summary> Checks if RamdiskId property is set </summary> <returns>true if RamdiskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithUserData(System.String)"> <summary> Sets the MIME, Base64-encoded user data. </summary> <param name="userData">MIME, Base64-encoded user data.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetUserData"> <summary> Checks if UserData property is set </summary> <returns>true if UserData property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithDisableApiTermination(System.Boolean)"> <summary> Sets whether the instance can be terminated. </summary> <param name="disableApiTermination">Specifies whether the instance can be terminated. You must modify this attribute before you can terminate any "locked" instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetDisableApiTermination"> <summary> Checks if DisableApiTermination property is set </summary> <returns>true if DisableApiTermination property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithInstanceInitiatedShutdownBehavior(System.String)"> <summary> Sets whether the instance's Amazon EBS volumes are deleted when the instance is shut down. </summary> <param name="instanceInitiatedShutdownBehavior">Specifies whether the instance's Amazon EBS volumes are deleted when the instance is shut down. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetInstanceInitiatedShutdownBehavior"> <summary> Checks if InstanceInitiatedShutdownBehavior property is set </summary> <returns>true if InstanceInitiatedShutdownBehavior property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithRootDeviceName(System.String)"> <summary> Sets the root device name (e.g., /dev/sda1). </summary> <param name="rootDeviceName">The root device name (e.g., /dev/sda1).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetRootDeviceName"> <summary> Checks if RootDeviceName property is set </summary> <returns>true if RootDeviceName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithBlockDeviceMapping(Amazon.EC2.Model.InstanceBlockDeviceMapping[])"> <summary> Sets the block device mapping set. </summary> <param name="list">Block device mapping set.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithSourceDestCheck(System.Boolean)"> <summary> Sets whether source/destination checking is enabled on the instance. </summary> <param name="sourceDestCheck"> A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetSourceDestCheck"> <summary> Checks if the SourceDestCheck property is set </summary> <returns>true if the SourceDestCheck property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithGroupName(System.String[])"> <summary> Sets names of the security group. </summary> <param name="list">Names of the security groups.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetGroupName"> <summary> Checks if the GroupName property is set </summary> <returns>true if the GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithGroupId(System.String[])"> <summary> Sets IDs of the security groups. </summary> <param name="list">IDs of the security groups.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetGroupId"> <summary> Checks if the GroupId property is set </summary> <returns>true if the GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithProductCodes(Amazon.EC2.Model.ProductCode[])"> <summary> Sets the product codes. </summary> <param name="list">list of product codes and types</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetProductCodes"> <summary> Checks if the ProductCodes property is set </summary> <returns>true if the ProductCodes property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithEbsOptimized(System.Boolean)"> <summary> Sets whether to use the EBS IOPS optimized option. </summary> <param name="ebsOptimized">Specifies whether to use the EBS IOPS optimized option.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.IsSetEbsOptimized"> <summary> Checks if EbsOptimized property is set </summary> <returns>true if EbsOptimized property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceAttribute.WithSriovNetSupport(System.String)"> <summary> Sets whether enhanced networking is enabled for the instance. </summary> <param name="sriovNetSupport">A value of 'simple' means that enhanced networking is enabled.</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.InstanceId"> <summary> The ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.InstanceType"> <summary> The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and so on). </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.KernelId"> <summary> The kernel ID. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.RamdiskId"> <summary> The RAM disk ID. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.UserData"> <summary> MIME, Base64-encoded user data. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.DisableApiTermination"> <summary> Whether the instance can be terminated. You must modify this attribute before you can terminate any "locked" instances. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.InstanceInitiatedShutdownBehavior"> <summary> Whether the instance's Amazon EBS volumes are deleted when the instance is shut down. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.RootDeviceName"> <summary> The root device name (e.g., /dev/sda1). </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.BlockDeviceMapping"> <summary> Block device mapping set. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.SourceDestCheck"> <summary> Whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.GroupName"> <summary> Names of the security group. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.GroupId"> <summary> IDs of the security groups. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.ProductCodes"> <summary> Product codes. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.EbsOptimized"> <summary> Whether to use the EBS IOPS optimized option. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.SriovNetSupport"> <summary> Enhanced networking for the instance. A value of simple means that enhanced networking is enabled </summary> </member> <member name="T:Amazon.EC2.Model.InstanceBlockDeviceMapping"> <summary> Instance block device mapping set. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMapping.WithDeviceName(System.String)"> <summary> Sets the device name exposed to the instance (e.g., /dev/sdh). </summary> <param name="deviceName">The device name (e.g., /dev/sdh).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMapping.IsSetDeviceName"> <summary> Checks if DeviceName property is set </summary> <returns>true if DeviceName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMapping.WithEbs(Amazon.EC2.Model.InstanceEbsBlockDevice)"> <summary> Sets the parameters used to automatically set up Amazon EBS volumes when the instance is launched. </summary> <param name="ebs">Ebs property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMapping.IsSetEbs"> <summary> Checks if Ebs property is set </summary> <returns>true if Ebs property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMapping.DeviceName"> <summary> The device name exposed to the instance (e.g., /dev/sdh). </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMapping.Ebs"> <summary> Parameters used to automatically set up Amazon EBS volumes when the instance is launched. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter"> <summary> Instance block device mapping parameter. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.WithDeviceName(System.String)"> <summary> Sets the device name exposed to the instance (e.g., /dev/sdh). </summary> <param name="deviceName">The device name (e.g., /dev/sdh).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.IsSetDeviceName"> <summary> Checks if DeviceName property is set </summary> <returns>true if DeviceName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.WithVirtualName(System.String)"> <summary> Sets the virtual device name. </summary> <param name="virtualName">The virtual device name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.IsSetVirtualName"> <summary> Checks if VirtualName property is set </summary> <returns>true if VirtualName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.WithEbs(Amazon.EC2.Model.InstanceEbsBlockDeviceParameter)"> <summary> Sets parameters used to automatically setup Amazon EBS volumes when the instance is launched. </summary> <param name="ebs">Specifies parameters used to automatically setup Amazon EBS volumes when the instance is launched.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.IsSetEbs"> <summary> Checks if Ebs property is set </summary> <returns>true if Ebs property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.WithNoDevice(System.String)"> <summary> Sets the device name (e.g., /dev/sdb) to suppress during instance launch. </summary> <param name="noDevice">Specifies the device name (e.g., /dev/sdb) to suppress during instance launch.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.IsSetNoDevice"> <summary> Checks if NoDevice property is set </summary> <returns>true if NoDevice property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.DeviceName"> <summary> The device name exposed to the instance (e.g., /dev/sdh). </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.VirtualName"> <summary> The virtual device name. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.Ebs"> <summary> Parameters used to automatically setup Amazon EBS volumes when the instance is launched. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingParameter.NoDevice"> <summary> The device name (e.g., /dev/sdb) to suppress during instance launch. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceCounts"> <summary> Instance counts </summary> </member> <member name="M:Amazon.EC2.Model.InstanceCounts.IsSetState"> <summary> Checks if the State property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceCounts.IsSetInstanceCount"> <summary> Checks if the InstanceCount property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceCounts.State"> <summary> The state of the listed Reserved Instances. </summary> <remarks>Possible values = "available", "sold", "cancelled" or "pending"</remarks> </member> <member name="P:Amazon.EC2.Model.InstanceCounts.InstanceCount"> <summary> The number of listed Reserved Instances in the state specified by the State property. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceEbsBlockDevice"> <summary> Instance EBS block device. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.WithVolumeId(System.String)"> <summary> Sets the ID of the Amazon EBS volume. </summary> <param name="volumeId">The ID of the Amazon EBS volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.WithStatus(System.String)"> <summary> Sets the attachment state of the EBS volume. </summary> <param name="status">Attachment state of the EBS volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.WithAttachTime(System.String)"> <summary> Sets the time the volume was attached. </summary> <param name="attachTime">Time the volume was attached.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.IsSetAttachTime"> <summary> Checks if AttachTime property is set </summary> <returns>true if AttachTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.WithDeleteOnTermination(System.Boolean)"> <summary> Sets whether the volume will be deleted on instance termination. </summary> <param name="deleteOnTermination">Whether the volume will be deleted on instance termination.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDevice.IsSetDeleteOnTermination"> <summary> Checks if DeleteOnTermination property is set </summary> <returns>true if DeleteOnTermination property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceEbsBlockDevice.VolumeId"> <summary> The ID of the Amazon EBS volume. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceEbsBlockDevice.Status"> <summary> Attachment state of the EBS volume. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceEbsBlockDevice.AttachTime"> <summary> Time the volume was attached. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceEbsBlockDevice.DeleteOnTermination"> <summary> Whether the volume will be deleted on instance termination. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceEbsBlockDeviceParameter"> <summary> Instance EBS block device parameter. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDeviceParameter.WithVolumeId(System.String)"> <summary> Sets the ID of the Amazon EBS volume. </summary> <param name="volumeId">The ID of the Amazon EBS volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDeviceParameter.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDeviceParameter.WithDeleteOnTermination(System.Boolean)"> <summary> Sets whether the Amazon EBS volume is deleted on instance termination. </summary> <param name="deleteOnTermination">Specifies whether the Amazon EBS volume is deleted on instance termination.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceEbsBlockDeviceParameter.IsSetDeleteOnTermination"> <summary> Checks if DeleteOnTermination property is set </summary> <returns>true if DeleteOnTermination property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceEbsBlockDeviceParameter.VolumeId"> <summary> The ID of the Amazon EBS volume. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceEbsBlockDeviceParameter.DeleteOnTermination"> <summary> Whether the Amazon EBS volume is deleted on instance termination. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceExportTaskType"> <summary> Information about an instance being exported. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceExportTaskType.IsSetInstanceId"> <summary> Checks if the InstanceId property is set. </summary> <returns>True if the InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceExportTaskType.IsSetTargetEnvironment"> <summary> Checks if the TargetEnvironment property is set. </summary> <returns>True if the TargetEnvironment property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceExportTaskType.InstanceId"> <summary> The ID of the resource being exported. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceExportTaskType.TargetEnvironment"> <summary> The target virtualization environment. </summary> <remarks> Valid Values: vmware | citrix </remarks> </member> <member name="T:Amazon.EC2.Model.InstanceLicense"> <summary> An active license in use and attached to an Amazon EC2 instance. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceLicense.WithPool(System.String)"> <summary> Sets the license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request. </summary> <param name="pool">The license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceLicense.IsSetPool"> <summary> Checks if Pool property is set </summary> <returns>true if Pool property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceLicense.Pool"> <summary> The license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceLicenseSpecification"> <summary> Information about which license pool to use if a license should be attached to a new Amazon EC2 instance. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceLicenseSpecification.WithPool(System.String)"> <summary> Sets the license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request. </summary> <param name="pool">The license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceLicenseSpecification.IsSetPool"> <summary> Checks if Pool property is set </summary> <returns>true if Pool property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceLicenseSpecification.Pool"> <summary> The license pool from which to take a license when starting Amazon EC2 instances in the associated RunInstances request. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceMonitoring"> <summary> Instance Monitoring </summary> </member> <member name="M:Amazon.EC2.Model.InstanceMonitoring.WithInstanceId(System.String)"> <summary> Sets the instance ID. </summary> <param name="instanceId">Instance ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceMonitoring.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceMonitoring.WithMonitoring(Amazon.EC2.Model.Monitoring)"> <summary> Sets the State of monitoring for the instance. </summary> <param name="monitoring">State of monitoring for the instance. Valid Values: monitoring-enabled (enabled) | monitoring-pending (pending) | monitoring-disabled (disabled)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceMonitoring.IsSetMonitoring"> <summary> Checks if Monitoring property is set </summary> <returns>true if Monitoring property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceMonitoring.InstanceId"> <summary> Instance ID. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceMonitoring.Monitoring"> <summary> State of monitoring for the instance. Valid Values: monitoring-enabled (enabled) | monitoring-pending (pending) | monitoring-disabled (disabled) </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterface"> <summary> Instance Network Interface </summary> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface. </summary> <param name="networkInterfaceId">The ID of the network interface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet. </summary> <param name="subnetId">The ID of the subnet</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetSubnetId"> <summary> Checks if the SubnetId property is set </summary> <returns>true if the SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithVpcId(System.String)"> <summary> Sets the ID of the VPC. </summary> <param name="vpcId">The ID of the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetVpcId"> <summary> Checks if the VpcId property is set </summary> <returns>true if the VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithDescription(System.String)"> <summary> Sets the description of the interface. </summary> <param name="description">Description</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>true if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithOwnerId(System.String)"> <summary> Sets the ID of the customer who created the interface. </summary> <param name="ownerId">The ID of the customer who created the interface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetOwnerId"> <summary> Checks if the OwnerId property is set </summary> <returns>true if the OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithStatus(System.String)"> <summary> Sets the status of the interface. </summary> <param name="status">"available" or "in-use"</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetStatus"> <summary> Checks if the Status property is set </summary> <returns>true if the Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithMacAddress(System.String)"> <summary> Sets the MAC address of the interface within the subnet. </summary> <param name="macAddress">MAC address of the interface within the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetMacAddress"> <summary> Checks if the MacAddress property is set </summary> <returns>true if the MacAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithPrivateIpAddress(System.String)"> <summary> Sets the IP address of the interface within the subnet. </summary> <param name="privateIpAddress">IP address of the interface within the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetPrivateIpAddress"> <summary> Checks if the PrivateIpAddress property is set </summary> <returns>true if the PrivateIpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithPrivateDnsName(System.String)"> <summary> Sets the private DNS name. </summary> <param name="privateDnsName">Private Dns Name</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetPrivateDnsName"> <summary> Checks if the PrivateDnsName property is set </summary> <returns>true if the PrivateDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithSourceDestCheck(System.Boolean)"> <summary> Sets whether traffic to or from the instance is validated. </summary> <param name="sourceDestCheck">Flag indicating whether traffic to or from the instance is validated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetSourceDestCheck"> <summary> Checks if the SourceDestCheck property is set </summary> <returns>true if the SourceDestCheck property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithGroupId(System.String[])"> <summary> Sets the security groups for the interface. </summary> <param name="list">A list of security groups the instance is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithGroupName(System.String[])"> <summary> Sets the security group names for the interface. </summary> <param name="list">A list of security groups the instance is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithAttachment(Amazon.EC2.Model.InstanceNetworkInterfaceAttachment)"> <summary> Sets the network interface attachment. </summary> <param name="attachment">Network Interface Attachment</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetAttachment"> <summary> Checks if the Attachment property is set </summary> <returns>true if the Attachment property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithAssociation(Amazon.EC2.Model.InstanceNetworkInterfaceAssociation)"> <summary> Sets the association information for an Elastic IP associated with the network interface. </summary> <param name="association">Instance Network Interface Association</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetAssociation"> <summary> Checks if the Association property is set </summary> <returns>true if the Association property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.WithPrivateIpAddresses(Amazon.EC2.Model.InstancePrivateIpAddress[])"> <summary> Sets the private IP addresses associated with the network interface. </summary> <param name="privateIpAddresses">Private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterface.IsSetPrivateIpAddresses"> <summary> Checks if the PrivateIpAddresses property is set </summary> <returns>true if the PrivateIpAddresses property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.NetworkInterfaceId"> <summary> The ID of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.SubnetId"> <summary> The ID of the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.VpcId"> <summary> The ID of the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Description"> <summary> Description of the interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.OwnerId"> <summary> The ID of the customer who created the interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Status"> <summary> Status of the interface. Valid values: "available" | "in-use". </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.MacAddress"> <summary> MAC address of the interface within the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.PrivateIpAddress"> <summary> IP address of the interface within the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.PrivateDnsName"> <summary> Private DNS name. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.SourceDestCheck"> <summary> Whether traffic to or from the instance is validated. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.GroupId"> <summary> Security group IDs for the interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.GroupName"> <summary> Security group names for the interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Attachment"> <summary> The network interface attachment. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Association"> <summary> The association information for an Elastic IP associated with the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.PrivateIpAddresses"> <summary> The private IP addresses associated with the network interface. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation"> <summary> Instance Network Interface Association </summary> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.WithPublicIp(System.String)"> <summary> Sets the address of the Elastic IP address bound to the network interface. </summary> <param name="publicIp">Public IP</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.IsSetPublicIp"> <summary> Checks if the PublicIp property is set </summary> <returns>true if the PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.WithPublicDnsName(System.String)"> <summary> Sets the DNS name for the network interface. </summary> <param name="publicDnsName">PublicDnsName</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.IsSetPublicDnsName"> <summary> Checks if the PublicDnsName property is set </summary> <returns>true if the PublicDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.WithIpOwnerId(System.String)"> <summary> Sets the ID of the Elastic IP address owner. </summary> <param name="ipOwnerId">IP Owner ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.IsSetIpOwnerId"> <summary> Checks if the IpOwnerId property is set </summary> <returns>true if the IpOwnerId property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.PublicIp"> <summary> The address of the Elastic IP address bound to the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.PublicDnsName"> <summary> The DNS name for the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.IpOwnerId"> <summary> The ID of the Elastic IP address owner. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment"> <summary> Instance Network Interface Attachment </summary> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.WithAttachmentId(System.String)"> <summary> Sets the ID of the attachment. </summary> <param name="attachmentId">ID of the attachment</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.IsSetAttachmentId"> <summary> Checks if the AttachmentId property is set </summary> <returns>true if the AttachmentId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.WithDeviceIndex(System.Int32)"> <summary> Sets the index of the device for the network interface attachment on the instance. </summary> <param name="deviceIndex">The device index</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.IsSetDeviceIndex"> <summary> Checks if the DeviceIndex property is set </summary> <returns>true if the DeviceIndex property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.WithStatus(System.String)"> <summary> Sets the status of the attachment. </summary> <param name="status">Attachment status</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.IsSetStatus"> <summary> Checks if the Status property is set </summary> <returns>true if the Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.WithAttachTime(System.String)"> <summary> Sets the time stamp when the attachment initiated. </summary> <param name="attachTime">Attach Time</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.IsSetAttachTime"> <summary> Checks if the AttachTime property is set </summary> <returns>true if the AttachTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.WithDeleteOnTermination(System.Boolean)"> <summary> Sets whether the attachment is deleted on instance termination. </summary> <param name="deleteOnTermination">True if the attachment should be deleted on termination</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.IsSetDeleteOnTermination"> <summary> Checks if the DeleteOnTermination property is set </summary> <returns>true if the DeleteOnTermination property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.AttachmentId"> <summary> The ID of the attachment. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.DeviceIndex"> <summary> The index of the device for the network interface attachment on the instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.Status"> <summary> Status of the attachment. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.AttachTime"> <summary> The time stamp when the attachment initiated. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.DeleteOnTermination"> <summary> Whether the attachment is deleted on instance termination. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification"> <summary> Instance Network Interface Specification </summary> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithAssociatePublicIpAddress(System.Boolean)"> <summary> Indicates whether to assign a public IP address to an instance in a VPC. </summary> <remarks> <para>The public IP address is associated with a specific network interface. If set to <b>true</b>, the following rules apply:</para> <ol> <li> <p>Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.</p> </li> <li> <p>Can only be associated with a new network interface, not an existing one.</p> </li> </ol> <p> Default: If launching into a default subnet, the default value is <b>true</b>. If launching into a nondefault subnet, the default value is <b>false</b>. </p> </remarks> <param name="associatePublicIpAddress">Indicates whether to assign a public IP address to an instance in a VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetAssociatePublicIpAddress"> <summary> Checks if the AssociatePublicIpAddress property is set. </summary> <returns>true if the AssociatePublicIpAddress property is set.</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithNetworkInterfaceId(System.String)"> <summary> An existing interface to attach to a single instance. Requires n=1 instances. </summary> <param name="networkInterfaceId">The network interface ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetNetworkInterfaceId"> <summary> Checks if NetworkInterfaceId property is set </summary> <returns>true if NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithDeviceIndex(System.Int32)"> <summary> The device index. Applies to both attaching an existing network interface and when creating a network interface. </summary> <remarks> Condition: If you are specifying a network interface in the request, you must provide the device index. </remarks> <param name="deviceIndex">The index of the device on the instance for the network interface attachment.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetDeviceIndex"> <summary> Checks if the DeviceIndex property is set </summary> <returns>true if the DeviceIndex property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithSubnetId(System.String)"> <summary> The subnet ID. Applies only when creating a network interface. </summary> <param name="subnetId">The ID of the subnet associated with the network string.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetSubnetId"> <summary> Checks if the SubnetId property is set </summary> <returns>true if the SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithDescription(System.String)"> <summary> A description. Applies only when creating a network interface. </summary> <param name="description">The description of the network interface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>true if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithPrivateIpAddress(System.String)"> <summary> The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch. </summary> <param name="ipAddress">IP address of the network interface</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetPrivateIpAddress"> <summary> Checks if the PrivateIpAddress property is set </summary> <returns>true of the PrivateIpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithGroupId(System.String[])"> <summary> Sets the group IDs for use by the network interface. </summary> <param name="list">The group IDs for use by the network interface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetGroupId"> <summary> Checks if the GroupId property is set </summary> <returns>true if the GroupId is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithDeleteOnTermination(System.Boolean)"> <summary> Sets whether the interface will be deleted when the instance is terminated. </summary> <param name="deleteOnTermination">true to delete the interface when the instance is terminated</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetDeleteOnTermination"> <summary> Checks if the DeleteOnTermination property is set </summary> <returns>true if the DeleteOnTermination property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithPrivateIpAddresses(Amazon.EC2.Model.PrivateIpAddress[])"> <summary> Sets private IP addresses. </summary> <param name="privateIpAddresses">Private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetPrivateIpAddresses"> <summary> Checks if the PrivateIpAddresses property is set </summary> <returns>true if the PrivateIpAddresses property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.WithSecondaryPrivateIpAddressCount(System.Int32)"> <summary> Sets the number of secondary private IP addresses. </summary> <param name="secondaryPrivateIpAddressCount">Number of secondary private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.IsSetSecondaryPrivateIpAddressCount"> <summary> Checks if the SecondaryPrivateIpAddressCount property is set </summary> <returns>true if the SecondaryPrivateIpAddressCount property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.AssociatePublicIpAddress"> <summary> Indicates whether to assign a public IP address to an instance in a VPC. </summary> <remarks> <para>The public IP address is associated with a specific network interface. If set to <b>true</b>, the following rules apply:</para> <ol> <li> <p>Can only be associated with a single network interface with the device index of 0. You can't associate a public IP address with a second network interface, and you can't associate a public IP address if you are launching more than one network interface.</p> </li> <li> <p>Can only be associated with a new network interface, not an existing one.</p> </li> </ol> <p> Default: If launching into a default subnet, the default value is <b>true</b>. If launching into a nondefault subnet, the default value is <b>false</b>. </p> </remarks> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.NetworkInterfaceId"> <summary> An existing interface to attach to a single instance. Requires n=1 instances. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.DeviceIndex"> <summary> The device index. Applies to both attaching an existing network interface and when creating a network interface. </summary> <remarks> Condition: If you are specifying a network interface in the request, you must provide the device index. </remarks> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.SubnetId"> <summary> The subnet ID. Applies only when creating a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.Description"> <summary> A description. Applies only when creating a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.PrivateIpAddress"> <summary> The primary private IP address. Applies only when creating a network interface. Requires n=1 network interfaces in launch. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.GroupId"> <summary> The group IDs for use by the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.DeleteOnTermination"> <summary> Whether the interface will be deleted when the instance is terminated. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.PrivateIpAddresses"> <summary> Private IP addresses. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.SecondaryPrivateIpAddressCount"> <summary> Number of secondary private IP addresses. </summary> </member> <member name="T:Amazon.EC2.Model.InstancePrivateIpAddress"> <summary> Instance Private Ip Address </summary> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.WithIpAddress(System.String)"> <summary> Sets the private IP address. </summary> <param name="ipAddress">Private IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.IsSetIpAddress"> <summary> Checks if the IpAddress property is set </summary> <returns>true if the IpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.WithPrivateDnsName(System.String)"> <summary> Sets the private DNS name. </summary> <param name="privateDnsName">Private DNS name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.IsSetPrivateDnsName"> <summary> Checks if the PrivateDnsName property is set </summary> <returns>true if the PrivateDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.WithPrimary(System.Boolean)"> <summary> Sets whether this is a primary IP. </summary> <param name="primary">Whether this is a primary IP.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.IsSetPrimary"> <summary> Checks if the Primary property is set </summary> <returns>true if the Primary property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.WithAssociation(Amazon.EC2.Model.InstanceNetworkInterfaceAssociation)"> <summary> Sets the Instance Network Interface Association. </summary> <param name="association">Instance Network Interface Association.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstancePrivateIpAddress.IsSetAssociation"> <summary> Checks if the Association property is set </summary> <returns>true if the Association property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.IpAddress"> <summary> Private IP address. </summary> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.PrivateDnsName"> <summary> Private DNS name. </summary> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.Primary"> <summary> Whether this is a primary IP. </summary> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.Association"> <summary> Instance Network Interface Association. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceState"> <summary> Instance State </summary> </member> <member name="M:Amazon.EC2.Model.InstanceState.WithCode(System.Decimal)"> <summary> Sets the code representing the state of the instance. </summary> <param name="code"> A 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. Valid values are: 0 (pending) | 16 (running) | 32 (shutting-down) | 48 (terminated) | 64 (stopping) | 80 (stopped) </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceState.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceState.WithName(System.String)"> <summary> Sets the current state of the instance. </summary> <param name="name">The current state of the instance. Valid values are: pending | running | shutting-down | terminated | stopping | stopped</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceState.IsSetName"> <summary> Checks if Name property is set </summary> <returns>true if Name property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceState.Code"> <summary> A code representing the state of the instance. </summary> <remarks> A 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. Valid values are: 0 (pending) | 16 (running) | 32 (shutting-down) | 48 (terminated) | 64 (stopping) | 80 (stopped) </remarks> </member> <member name="P:Amazon.EC2.Model.InstanceState.Name"> <summary> The current state of the instance. Valid values are: pending | running | shutting-down | terminated | stopping | stopped </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStateChange"> <summary> Instance state change </summary> </member> <member name="M:Amazon.EC2.Model.InstanceStateChange.WithInstanceId(System.String)"> <summary> Sets the instance ID </summary> <param name="instanceId">Instance ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStateChange.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStateChange.WithCurrentState(Amazon.EC2.Model.InstanceState)"> <summary> Sets the current state </summary> <param name="currentState">Current state</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStateChange.IsSetCurrentState"> <summary> Checks if CurrentState property is set </summary> <returns>true if CurrentState property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStateChange.WithPreviousState(Amazon.EC2.Model.InstanceState)"> <summary> Sets the previous state </summary> <param name="previousState">Previous state</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStateChange.IsSetPreviousState"> <summary> Checks if PreviousState property is set </summary> <returns>true if PreviousState property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceStateChange.InstanceId"> <summary> Instance ID </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStateChange.CurrentState"> <summary> Current state </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStateChange.PreviousState"> <summary> Previous state </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatus"> <summary> Information about the status of an instance. </summary> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.WithInstanceId(System.String)"> <summary> Sets the instance ID </summary> <param name="instanceId">Unique ID of the instance launched.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.IsSetInstanceId"> <summary> Checks if the InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.WithAvailabilityZone(System.String)"> <summary> Sets the instance's availability zone. </summary> <param name="availabilityZone">The value to set for the AvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.IsSetAvailabilityZone"> <summary> Check if the AvailabilityZone property is set </summary> <returns>trie if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.WithInstanceStatusEvent(System.Collections.Generic.List{Amazon.EC2.Model.InstanceStatusEvent})"> <summary> Sets the extra information regarding instance status. </summary> <param name="instanceStatusEvent">Collection of InstanceStatusEvent instances</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.IsSetInstanceStatusEvent"> <summary> Checks if the InstanceStatusEvent property is set </summary> <returns>true of the collection contains one or more events</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.WithInstanceState(Amazon.EC2.Model.InstanceState)"> <summary> Sets the current state of the instance. </summary> <param name="instanceState">The current state of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.IsSetInstanceState"> <summary> Checks if the InstanceState property is set </summary> <returns>true if the InstanceState property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.WithSystemStatusDetail(Amazon.EC2.Model.InstanceStatusDetail)"> <summary> Sets the system status detail. </summary> <param name="systemStatusDetail">System status</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.IsSetSystemStatusDetail"> <summary> Checks if the SystemStatusDetail property is set </summary> <returns>true if the SystemStatusDetail property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.WithInstanceStatusDetail(Amazon.EC2.Model.InstanceStatusDetail)"> <summary> Sets the instance status detail. </summary> <param name="instanceStatusDetail">Instance status</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatus.IsSetInstanceStatusDetail"> <summary> Checks if the InstanceStatusDetail property is set </summary> <returns>true if the InstanceStatusDetail property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.InstanceId"> <summary> Instance ID </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.AvailabilityZone"> <summary> The instance's availability zone. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.InstanceStatusEvent"> <summary> Extra information regarding instance status. </summary> <remarks> Reports impaired functionality that arises from problems internal to the instance . </remarks> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.InstanceState"> <summary> The current state of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.SystemStatusDetail"> <summary> System status detail. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.InstanceStatusDetail"> <summary> Instance status detail. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatusDetail"> <summary> Instance Status Detail </summary> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetail.WithStatus(System.String)"> <summary> Sets the status. </summary> <param name="status"> Valid Values: ok | impaired | insufficient-data </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetail.IsSetStatus"> <summary> Checks if the Status property is set. </summary> <returns>true if the Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetail.WithDetail(Amazon.EC2.Model.InstanceStatusDetailType[])"> <summary> Sets the specific information about system instance health or application instance health. </summary> <param name="list">Set of InstanceStatusDetailType instances</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetail.IsSetDetail"> <summary> Checks if the Detail property is set. </summary> <returns>true if the Detail property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetail.Status"> <summary> The status. Valid Values: ok | impaired | insufficient-data </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetail.Detail"> <summary> Specific information about system instance health or application instance health. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatusDetailType"> <summary> Instance Status Detail Type </summary> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetailType.WithName(System.String)"> <summary> Sets the type of instance status detail. </summary> <param name="name"> The type of instance status detail. Valid Values: reachability </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetailType.IsSetName"> <summary> Checks if the Name property is set. </summary> <returns>true if the Name property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetailType.WithStatus(System.String)"> <summary> Sets the status. </summary> <param name="status"> Valid Values: passed | failed | insufficient-data </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetailType.IsSetStatus"> <summary> Checks if the Status property is set. </summary> <returns>true if the Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetailType.WithImpairedSince(System.String)"> <summary> Sets the time when a status check failed. </summary> <param name="impairedSince">The time of the status check failure</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusDetailType.IsSetImpairedSince"> <summary> Checks if the ImpairedSince property is set. </summary> <returns>True if the ImpairedSince property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetailType.Name"> <summary> The type of instance status detail. Valid Values: reachability </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetailType.Status"> <summary> The status. Valid Values: passed | failed | insufficient-data </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetailType.ImpairedSince"> <summary> The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched. </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatusEvent"> <summary> Details of a status event for an instance </summary> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.WithCode(System.String)"> <summary> Sets the associated code for the event. </summary> <param name="code">Valid parameters are instance-reboot|system-reboot|instance-retirement</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.IsSetCode"> <summary> Checks if the Code property is set. </summary> <returns>true of the Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.WithDescription(System.String)"> <summary> Sets a description for the event. </summary> <param name="description">Event description</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.IsSetDescription"> <summary> Checks if the Description property is set. </summary> <returns>true if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.WithNotBefore(System.String)"> <summary> Sets the earliest scheduled start time for the event. </summary> <param name="notBefore">Scheduled start time</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.IsSetNotBefore"> <summary> Checks if the NotBefore property is set </summary> <returns>true if the NotBefore property is set</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.WithNotAfter(System.String)"> <summary> Sets the latest scheduled end time for the event. </summary> <param name="notAfter">Scheduled end time</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InstanceStatusEvent.IsSetNotAfter"> <summary> Checks if the NotAfter property is set. </summary> <returns>true if the NotAfter property is set</returns> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.Code"> <summary> The associated code of the event. Valid values: instance-reboot | system-reboot | instance-retirement. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.Description"> <summary> A description of the event. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.NotBefore"> <summary> The earliest scheduled start time for the event. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.NotAfter"> <summary> The latest scheduled end time for the event. </summary> </member> <member name="T:Amazon.EC2.Model.InternetGateway"> <summary> Internet gateway description. </summary> </member> <member name="M:Amazon.EC2.Model.InternetGateway.WithInternetGatewayId(System.String)"> <summary> Sets the ID of the Internet gateway. </summary> <param name="internetGatewayId">The ID of the Internet gateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InternetGateway.IsSetInternetGatewayId"> <summary> Checks if InternetGatewayId property is set </summary> <returns>true if InternetGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InternetGateway.WithAttachments(Amazon.EC2.Model.InternetGatewayAttachment[])"> <summary> Sets the list of VPCs attached to the Internet gateway. </summary> <param name="list">A list of VPCs attached to the Internet gateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InternetGateway.IsSetAttachments"> <summary> Checks if Attachments property is set </summary> <returns>true if Attachments property is set</returns> </member> <member name="M:Amazon.EC2.Model.InternetGateway.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the list of tags for the License. </summary> <param name="list">A list of tags for the License.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InternetGateway.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.InternetGateway.InternetGatewayId"> <summary> The ID of the Internet gateway. </summary> </member> <member name="P:Amazon.EC2.Model.InternetGateway.Attachments"> <summary> A list of VPCs attached to the Internet gateway. </summary> </member> <member name="P:Amazon.EC2.Model.InternetGateway.Tag"> <summary> A list of tags for the License. </summary> </member> <member name="T:Amazon.EC2.Model.InternetGatewayAttachment"> <summary> Internet gateway attachment </summary> </member> <member name="M:Amazon.EC2.Model.InternetGatewayAttachment.WithVpcId(System.String)"> <summary> Sets the ID of the VPC the Internet gateway is attached to. </summary> <param name="vpcId">The ID of the VPC the Internet gateway is attached to.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InternetGatewayAttachment.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.InternetGatewayAttachment.WithState(System.String)"> <summary> Sets the current state of the attachment. </summary> <param name="state">The current state of the attachment.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.InternetGatewayAttachment.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="P:Amazon.EC2.Model.InternetGatewayAttachment.VpcId"> <summary> The ID of the VPC the Internet gateway is attached to. </summary> </member> <member name="P:Amazon.EC2.Model.InternetGatewayAttachment.State"> <summary> The current state of the attachment. </summary> </member> <member name="T:Amazon.EC2.Model.IpPermission"> <summary> IP Permission </summary> </member> <member name="M:Amazon.EC2.Model.IpPermission.WithIpProtocol(System.String)"> <summary> Sets the IP protocol. </summary> <param name="ipProtocol">IP protocol. Valid Values: tcp | udp | icmp</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.IsSetIpProtocol"> <summary> Checks if IpProtocol property is set </summary> <returns>true if IpProtocol property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.WithFromPort(System.Decimal)"> <summary> Sets the start of port range for the TCP and UDP protocols, or an ICMP type number. </summary> <param name="fromPort">Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.IsSetFromPort"> <summary> Checks if FromPort property is set </summary> <returns>true if FromPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.WithToPort(System.Decimal)"> <summary> Sets the end of port range for the TCP and UDP protocols, or an ICMP code. </summary> <param name="toPort">End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.IsSetToPort"> <summary> Checks if ToPort property is set </summary> <returns>true if ToPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.WithUserIdGroupPair(Amazon.EC2.Model.UserIdGroupPair[])"> <summary> Sets the list of security group and user ID pairs. </summary> <param name="list">List of security group and user ID pairs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.IsSetUserIdGroupPair"> <summary> Checks if UserIdGroupPair property is set </summary> <returns>true if UserIdGroupPair property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.WithIpRange(System.String[])"> <summary> Sets the list of IP ranges. </summary> <param name="list">IP ranges.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermission.IsSetIpRange"> <summary> Checks if IpRange property is set </summary> <returns>true if IpRange property is set</returns> </member> <member name="P:Amazon.EC2.Model.IpPermission.IpProtocol"> <summary> IP protocol. Valid Values: tcp | udp | icmp </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.FromPort"> <summary> Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number). </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.ToPort"> <summary> End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code). </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.UserIdGroupPair"> <summary> List of security group and user ID pairs. </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.IpRange"> <summary> A list of IP ranges. </summary> </member> <member name="T:Amazon.EC2.Model.IpPermissionSpecification"> <summary> IP Permission. </summary> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.WithIpProtocol(System.String)"> <summary> Sets the IP protocol. </summary> <param name="ipProtocol">IP protocol.Valid Values: tcp | udp | icmp</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.IsSetIpProtocol"> <summary> Checks if IpProtocol property is set </summary> <returns>true if IpProtocol property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.WithFromPort(System.Decimal)"> <summary> Sets the start of port range for the TCP and UDP protocols, or an ICMP type number. </summary> <param name="fromPort">Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.IsSetFromPort"> <summary> Checks if FromPort property is set </summary> <returns>true if FromPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.WithToPort(System.Decimal)"> <summary> Sets the end of port range for the TCP and UDP protocols, or an ICMP code. </summary> <param name="toPort">End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.IsSetToPort"> <summary> Checks if ToPort property is set </summary> <returns>true if ToPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.WithGroups(Amazon.EC2.Model.UserIdGroupPair[])"> <summary> Sets the list of security group and user ID pairs. </summary> <param name="list">List of security group and user ID pairs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.IsSetGroups"> <summary> Checks if Groups property is set </summary> <returns>true if Groups property is set</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.WithIpRanges(System.String[])"> <summary> Sets a list of IP ranges. </summary> <param name="list">IP ranges.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.IpPermissionSpecification.IsSetIpRanges"> <summary> Checks if IpRanges property is set </summary> <returns>true if IpRanges property is set</returns> </member> <member name="P:Amazon.EC2.Model.IpPermissionSpecification.IpProtocol"> <summary> IP protocol. Valid Values: tcp | udp | icmp </summary> </member> <member name="P:Amazon.EC2.Model.IpPermissionSpecification.FromPort"> <summary> Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number). </summary> </member> <member name="P:Amazon.EC2.Model.IpPermissionSpecification.ToPort"> <summary> End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code). </summary> </member> <member name="P:Amazon.EC2.Model.IpPermissionSpecification.Groups"> <summary> List of security group and user ID pairs. </summary> </member> <member name="P:Amazon.EC2.Model.IpPermissionSpecification.IpRanges"> <summary> A list of IP ranges. </summary> </member> <member name="T:Amazon.EC2.Model.KeyPair"> <summary> Key pair. </summary> </member> <member name="M:Amazon.EC2.Model.KeyPair.WithKeyName(System.String)"> <summary> Sets the name of the key pair. </summary> <param name="keyName">The key pair name provided in the original request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.KeyPair.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="M:Amazon.EC2.Model.KeyPair.WithKeyFingerprint(System.String)"> <summary> Sets the SHA-1 digest of the DER encoded private key. </summary> <param name="keyFingerprint">A SHA-1 digest of the DER encoded private key.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.KeyPair.IsSetKeyFingerprint"> <summary> Checks if KeyFingerprint property is set </summary> <returns>true if KeyFingerprint property is set</returns> </member> <member name="M:Amazon.EC2.Model.KeyPair.WithKeyMaterial(System.String)"> <summary> Set an unencrypted PEM encoded RSA private key. </summary> <param name="keyMaterial">Only returned on create</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.KeyPair.IsSetKeyMaterial"> <summary> Checks if KeyMaterial property is set </summary> <returns>true if KeyMaterial property is set</returns> </member> <member name="P:Amazon.EC2.Model.KeyPair.KeyName"> <summary> Name of the key pair. </summary> </member> <member name="P:Amazon.EC2.Model.KeyPair.KeyFingerprint"> <summary> A SHA-1 digest of the DER encoded private key. </summary> </member> <member name="P:Amazon.EC2.Model.KeyPair.KeyMaterial"> <summary> An unencrypted PEM encoded RSA private key. Only returned on during a create operation. </summary> </member> <member name="T:Amazon.EC2.Model.LaunchPermission"> <summary> Launch Permission </summary> </member> <member name="M:Amazon.EC2.Model.LaunchPermission.WithUserId(System.String)"> <summary> AWS Access Key ID. </summary> <param name="userId">AWS Access Key ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchPermission.IsSetUserId"> <summary> Checks if UserId property is set </summary> <returns>true if UserId property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchPermission.WithGroupName(System.String)"> <summary> Sets the name of the group. </summary> <param name="groupName">Name of the group. Currently supports "all."</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchPermission.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="P:Amazon.EC2.Model.LaunchPermission.UserId"> <summary> AWS Access Key ID. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchPermission.GroupName"> <summary> Name of the group. Valid values: "all." </summary> </member> <member name="T:Amazon.EC2.Model.LaunchSpecification"> <summary> Specifies additional launch instance information. </summary> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithImageId(System.String)"> <summary> Sets the AMI ID. </summary> <param name="imageId">The AMI ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithKeyName(System.String)"> <summary> Sets the name of the key pair. </summary> <param name="keyName">The name of the key pair.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithSecurityGroup(System.String[])"> <summary> Sets the Security Groups to associate the launched instance with. </summary> <param name="list">The Security Groups to associate the launched instance with.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetSecurityGroup"> <summary> Checks if SecurityGroup property is set </summary> <returns>true if SecurityGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithSecurityGroupId(System.String[])"> <summary> Sets the IDs of the security groups. </summary> <param name="list">IDs of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetSecurityGroupId"> <summary> Checks if SecurityGroupId property is set </summary> <returns>true if SecurityGroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithUserData(System.String)"> <summary> Sets the MIME, Base64-encoded user data. </summary> <param name="userData">MIME, Base64-encoded user data.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetUserData"> <summary> Checks if UserData property is set </summary> <returns>true if UserData property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithAddressingType(System.String)"> <summary> Sets Addressing type. </summary> <param name="addressingType">Deprecated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetAddressingType"> <summary> Checks if AddressingType property is set </summary> <returns>true if AddressingType property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithInstanceType(System.String)"> <summary> Sets the instance type. </summary> <param name="instanceType">Specifies the instance type. Valid values are: m1.small | m1.medium | m1.large | m1.xlarge | c1.medium | c1.xlarge | m2.2xlarge | m2.4xlarge. Default: m1.small</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithPlacement(Amazon.EC2.Model.Placement)"> <summary> Sets the placement constraints. </summary> <param name="placement">Specifies the placement constraints.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetPlacement"> <summary> Checks if Placement property is set </summary> <returns>true if Placement property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithKernelId(System.String)"> <summary> Sets the ID of the kernel to select. </summary> <param name="kernelId">The ID of the kernel to select.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetKernelId"> <summary> Checks if KernelId property is set </summary> <returns>true if KernelId property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithRamdiskId(System.String)"> <summary> Sets the ID of the RAM disk to select. </summary> <param name="ramdiskId">The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetRamdiskId"> <summary> Checks if RamdiskId property is set </summary> <returns>true if RamdiskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithBlockDeviceMapping(Amazon.EC2.Model.BlockDeviceMapping[])"> <summary> Sets the list of how block devices are exposed to the instance. </summary> <param name="list">Specifies how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithMonitoring(Amazon.EC2.Model.MonitoringSpecification)"> <summary> Sets whether to enable monitoring for the Spot Instance. </summary> <param name="monitoring">Specifies whether to enable monitoring for the Spot Instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetMonitoring"> <summary> Checks if Monitoring property is set </summary> <returns>true if Monitoring property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithSubnetId(System.String)"> <summary> Sets the Amazon VPC subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud. </summary> <param name="subnetId">Specifies the Amazon VPC subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithNetworkInterfaceSet(Amazon.EC2.Model.InstanceNetworkInterfaceSpecification[])"> <summary> Sets the list of Instance Network Interface Specifications. </summary> <param name="list">Collection of NetworkInterfaceSet</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetNetworkInterfaceSet"> <summary> Checks if the NetworkInterfaceSet property is set </summary> <returns>true if the NetworkInterfaceSet is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithInstanceProfile(Amazon.EC2.Model.IAMInstanceProfile)"> <summary> Sets an Identity and Access Management Instance Profile to associate with the instance. </summary> <param name="instanceProfile"> An Identity and Access Management Instance Profile to associate with the instance. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetInstanceProfile"> <summary> Checks if the InstanceProfile property is set </summary> <returns>true if the InstanceProfile property is set</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.WithEbsOptimized(System.Boolean)"> <summary> Sets whether to use the EBS IOPS optimized option. </summary> <param name="ebsOptimized">Specifies whether to use the EBS IOPS optimized option.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LaunchSpecification.IsSetEbsOptimized"> <summary> Checks if EbsOptimized property is set </summary> <returns>true if EbsOptimized property is set</returns> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.ImageId"> <summary> The AMI ID. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.KeyName"> <summary> The name of the key pair. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.SecurityGroup"> <summary> The Security Groups to associate the launched instance with. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.SecurityGroupId"> <summary> IDs of the security groups. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.UserData"> <summary> MIME, Base64-encoded user data. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.AddressingType"> <summary> Addressing type. Deprecated. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.InstanceType"> <summary> The instance type. Valid values are: m1.small | m1.medium | m1.large | m1.xlarge | c1.medium | c1.xlarge | m2.2xlarge | m2.4xlarge. Default: m1.small </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.Placement"> <summary> Placement constraints. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.KernelId"> <summary> The ID of the kernel to select. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.RamdiskId"> <summary> The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.BlockDeviceMapping"> <summary> List of how block devices are exposed to the instance. Each mapping is made up of a virtualName and a deviceName. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.Monitoring"> <summary> Whether to enable monitoring for the Spot Instance. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.SubnetId"> <summary> Amazon VPC subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.NetworkInterfaceSet"> <summary> List of Instance Network Interface Specifications. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.InstanceProfile"> <summary> An Identity and Access Management Instance Profile to associate with the instance. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.EbsOptimized"> <summary> Whether to use the EBS IOPS optimized option. </summary> </member> <member name="T:Amazon.EC2.Model.License"> <summary> A software license that can be associated with an Amazon EC2 instance when launched (ex. a Microsoft Windows license). </summary> </member> <member name="M:Amazon.EC2.Model.License.WithLicenseId(System.String)"> <summary> Sets the unique ID identifying the license. </summary> <param name="licenseId">The unique ID identifying the license.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.License.IsSetLicenseId"> <summary> Checks if LicenseId property is set </summary> <returns>true if LicenseId property is set</returns> </member> <member name="M:Amazon.EC2.Model.License.WithType(System.String)"> <summary> Sets the license type (ex. "Microsoft/Windows/Standard"). </summary> <param name="type">The license type (ex. "Microsoft/Windows/Standard").</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.License.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.License.WithPool(System.String)"> <summary> Sets the name of the pool in which the license is kept. </summary> <param name="pool">The name of the pool in which the license is kept.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.License.IsSetPool"> <summary> Checks if Pool property is set </summary> <returns>true if Pool property is set</returns> </member> <member name="M:Amazon.EC2.Model.License.WithLicenseCapacity(Amazon.EC2.Model.LicenseCapacity[])"> <summary> Sets the capacities available for this license. </summary> <param name="list">The capacities available for this license, indicating how many licenses are in use, how many are available, how many Amazon EC2 instances can be supported, etc.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.License.IsSetLicenseCapacity"> <summary> Checks if LicenseCapacity property is set </summary> <returns>true if LicenseCapacity property is set</returns> </member> <member name="M:Amazon.EC2.Model.License.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets a list of tags for the License. </summary> <param name="list">A list of tags for the License.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.License.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.License.LicenseId"> <summary> The unique ID identifying the license. </summary> </member> <member name="P:Amazon.EC2.Model.License.Type"> <summary> The license type (ex. "Microsoft/Windows/Standard"). </summary> </member> <member name="P:Amazon.EC2.Model.License.Pool"> <summary> The name of the pool in which the license is kept. </summary> </member> <member name="P:Amazon.EC2.Model.License.LicenseCapacity"> <summary> The capacities available for this license, indicating how many licenses are in use, how many are available, how many Amazon EC2 instances can be supported, etc. </summary> </member> <member name="P:Amazon.EC2.Model.License.Tag"> <summary> A list of tags for the License. </summary> </member> <member name="T:Amazon.EC2.Model.LicenseCapacity"> <summary> Capacity that a license is able to support. </summary> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.WithCapacity(System.Decimal)"> <summary> Sets the number of licenses available. </summary> <param name="capacity">The number of licenses available.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.IsSetCapacity"> <summary> Checks if Capacity property is set </summary> <returns>true if Capacity property is set</returns> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.WithInstanceCapacity(System.Decimal)"> <summary> Sets the number of Amazon EC2 instances that can be supported with the license's capacity. </summary> <param name="instanceCapacity">The number of Amazon EC2 instances that can be supported with the license's capacity.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.IsSetInstanceCapacity"> <summary> Checks if InstanceCapacity property is set </summary> <returns>true if InstanceCapacity property is set</returns> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.WithState(System.String)"> <summary> Sets the state of this license capacity, indicating whether the license is actively being used or not. </summary> <param name="state">The state of this license capacity, indicating whether the license is actively being used or not.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.WithEarliestAllowedDeactivationTime(System.String)"> <summary> Sets the earliest allowed time at which a license can be deactivated. </summary> <param name="earliestAllowedDeactivationTime">The earliest allowed time at which a license can be deactivated. Some licenses have time restrictions on when they can be activated and reactivated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.LicenseCapacity.IsSetEarliestAllowedDeactivationTime"> <summary> Checks if EarliestAllowedDeactivationTime property is set </summary> <returns>true if EarliestAllowedDeactivationTime property is set</returns> </member> <member name="P:Amazon.EC2.Model.LicenseCapacity.Capacity"> <summary> The number of licenses available. </summary> </member> <member name="P:Amazon.EC2.Model.LicenseCapacity.InstanceCapacity"> <summary> The number of Amazon EC2 instances that can be supported with the license's capacity. </summary> </member> <member name="P:Amazon.EC2.Model.LicenseCapacity.State"> <summary> The state of this license capacity, indicating whether the license is actively being used or not. </summary> </member> <member name="P:Amazon.EC2.Model.LicenseCapacity.EarliestAllowedDeactivationTime"> <summary> The earliest allowed time at which a license can be deactivated. Some licenses have time restrictions on when they can be activated and reactivated. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyImageAttributeRequest"> <summary> Modifies an attribute of an AMI </summary> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.WithImageId(System.String)"> <summary> Sets the AMI ID. </summary> <param name="imageId">The AMI ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.WithAttribute(System.String)"> <summary> Sets the attribute to modify. </summary> <param name="attribute">Specifies the attribute to modify. Valid Values: launchPermission | productCodes</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.WithOperationType(System.String)"> <summary> Sets the operation to perform on the attribute. </summary> <param name="operationType">Specifies the operation to perform on the attribute. Valid Values: add | remove</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.IsSetOperationType"> <summary> Checks if OperationType property is set </summary> <returns>true if OperationType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.WithUserId(System.String[])"> <summary> Sets the AWS Access Key IDs to add/remove. </summary> <param name="list">AWS Access Key ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.IsSetUserId"> <summary> Checks if UserId property is set </summary> <returns>true if UserId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.WithUserGroup(System.String[])"> <summary> Sets names of the groups to add/remove. </summary> <param name="list">Name of the group. Currently supports "all."</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.IsSetUserGroup"> <summary> Checks if UserGroup property is set </summary> <returns>true if UserGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.WithProductCode(System.String[])"> <summary> Sets product codes to add. </summary> <param name="list">Product code.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.IsSetProductCode"> <summary> Checks if ProductCode property is set </summary> <returns>true if ProductCode property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.WithDescription(System.String)"> <summary> Sets the new description for the AMI. </summary> <param name="description">Description property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.ImageId"> <summary> The AMI ID. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.Attribute"> <summary> The attribute to modify. Valid Values: launchPermission | productCodes </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.OperationType"> <summary> The operation to perform on the attribute. Valid Values: add | remove </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.UserId"> <summary> AWS Access Key IDs to add/remove. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.UserGroup"> <summary> Names of the groups to add/remove. Currently supports "all." </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.ProductCode"> <summary> Product codes to add. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.Description"> <summary> New description for the AMI. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyImageAttributeResponse"> <summary> Modify Image Attribute Response </summary> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ModifyInstanceAttributeRequest"> <summary> Modifies an attribute of an instance. </summary> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.WithInstanceId(System.String)"> <summary> Sets the instance ID. </summary> <param name="instanceId">The instance ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.WithAttribute(System.String)"> <summary> Sets the name of the attribute to modify. </summary> <param name="attribute">Name of the attribute to modify. Values are "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "sourceDestCheck", "rootDeviceName", "blockDeviceMapping" and "ebsOptimized"</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.WithValue(System.String)"> <summary> Sets the new value of the attribute. </summary> <param name="value">New value of the attribute.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.IsSetValue"> <summary> Checks if Value property is set </summary> <returns>true if Value property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.WithBlockDeviceMapping(Amazon.EC2.Model.InstanceBlockDeviceMappingParameter[])"> <summary> Sets the new mapping that defines native device names to use when exposing virtual devices. </summary> <param name="list">Modifies the mapping that defines native device names to use when exposing virtual devices.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.WithGroupId(System.String[])"> <summary> Sets the new security groups that an instance belongs to. </summary> <param name="list">This is applicable only to instances running in a VPC. Use this parameter when you want to change the security groups an instance is in. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.InstanceId"> <summary> The instance ID. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.Attribute"> <summary> Name of the attribute to modify. </summary> <remarks> Valid values: "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "sourceDestCheck", "rootDeviceName", "blockDeviceMapping" and "ebsOptimized" </remarks> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.Value"> <summary> New value of the attribute. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.BlockDeviceMapping"> <summary> New mapping that defines native device names to use when exposing virtual devices. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.GroupId"> <summary> New security groups that an instance belongs to. </summary> <remarks> This is applicable only to instances running in a VPC. Use this parameter when you want to change the security groups an instance is in. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. </remarks> </member> <member name="T:Amazon.EC2.Model.ModifyInstanceAttributeResponse"> <summary> Information returned by a ModifyInstanceAttribute request. </summary> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ModifyNetworkInterfaceAttachment"> <summary> Modify Network Interface Attachment </summary> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttachment.WithAttachmentId(System.String)"> <summary> Sets the attachment ID. </summary> <param name="attachmentId">Attachment Id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttachment.IsSetAttachmentId"> <summary> Checks if the AttachmentId property is set </summary> <returns>true if the AttachmentId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttachment.WithDeleteOnTermination(System.Boolean)"> <summary> Sets whether the attachment is deleted on instance termination. </summary> <param name="deleteOnTermination">true to delete on termination</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttachment.IsSetDeleteOnTermination"> <summary> Checks if the DeleteOnTermination property is set </summary> <returns>true if the DeleteOnTermination property is set</returns> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttachment.AttachmentId"> <summary> Attachment ID. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttachment.DeleteOnTermination"> <summary> Whether the attachment is deleted on instance termination. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest"> <summary> Modifies a network interface attribute. Only one attribute can be specified per call. </summary> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface with the attributes that you want to modify. </summary> <param name="networkInterfaceId">The network interface ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.IsSetNetworkInterfaceId"> <summary> Checks if NetworkInterfaceId property is set </summary> <returns>true if NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.WithDescription(System.String)"> <summary> Sets the description of the network interface. </summary> <param name="description">Network interface description</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>true if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.WithSourceDestCheck(System.Boolean)"> <summary> Sets whether source/destination checking is enabled on the instance. </summary> <param name="sourceDestCheck"> True to enable a Network Address Translation (NAT) instance in a VPC to perform NAT. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.IsSetSourceDestCheck"> <summary> Checks if the SourceDestCheck property is set </summary> <returns>true if the SourceDestCheck property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.WithGroupId(System.String[])"> <summary> Sets the full set of group IDs to associate with the network interface. </summary> <param name="list"> The full set of group IDs to associate with the network interface. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.IsSetGroupId"> <summary> Checks if the GroupId property is set </summary> <returns>true if the GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.WithModifyNetworkInterfaceAttachment(Amazon.EC2.Model.ModifyNetworkInterfaceAttachment)"> <summary> Sets the Interface attachment. </summary> <param name="attachment">Modify network interface attachment</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.IsSetAttachment"> <summary> Checks if the Attachment property is set </summary> <returns>true if the Attachment property is set</returns> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.NetworkInterfaceId"> <summary> The ID of the network interface with the attributes that you want to modify. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.Description"> <summary> The description of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.SourceDestCheck"> <summary> Whether source/destination checking is enabled on the instance. </summary> <remarks> This attribute exists to enable a Network Address Translation (NAT) instance in a VPC to perform NAT. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, go to NAT Instances in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.GroupId"> <summary> The full set of group IDs to associate with the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.Attachment"> <summary> Interface attachment. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeResponse"> <summary> Modify Network Interface Attribute response </summary> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ModifySnapshotAttributeRequest"> <summary> Adds or remove permission settings for the specified snapshot </summary> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.WithSnapshotId(System.String)"> <summary> Sets the ID of the snapshot. </summary> <param name="snapshotId">The ID of the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.WithAttribute(System.String)"> <summary> Sets the attribute to modify. </summary> <param name="attribute">Specifies the attribute to modify. Valid Values: createVolumePermission</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.WithOperationType(System.String)"> <summary> Sets the operation to perform on the attribute. </summary> <param name="operationType">Specifies the operation to perform on the attribute. Valid Values: add | remove</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.IsSetOperationType"> <summary> Checks if OperationType property is set </summary> <returns>true if OperationType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.WithUserId(System.String[])"> <summary> Sets the user ID of a user that can create volumes from the snapshot. </summary> <param name="list">User ID of a user that can create volumes from the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.IsSetUserId"> <summary> Checks if UserId property is set </summary> <returns>true if UserId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.WithUserGroup(System.String[])"> <summary> Sets the group that is allowed to create volumes from the snapshot. </summary> <param name="list">Group that is allowed to create volumes from the snapshot (currently supports "all").</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.IsSetUserGroup"> <summary> Checks if UserGroup property is set </summary> <returns>true if UserGroup property is set</returns> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.SnapshotId"> <summary> The ID of the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.Attribute"> <summary> The attribute to modify. Valid Values: createVolumePermission </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.OperationType"> <summary> The operation to perform on the attribute. Valid Values: add | remove </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.UserId"> <summary> User ID of a user that can create volumes from the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.UserGroup"> <summary> Group that is allowed to create volumes from the snapshot. Valid values: "all". </summary> </member> <member name="T:Amazon.EC2.Model.ModifySnapshotAttributeResponse"> <summary> Modify Snapshot Attribute Response </summary> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVolumeAttributeRequest"> <summary> Modifies a volume attribute. </summary> </member> <member name="M:Amazon.EC2.Model.ModifyVolumeAttributeRequest.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVolumeAttributeRequest.WithVolumeId(System.String)"> <summary> Sets the volume against which to make the modify call. </summary> <param name="volumeId">The new volume id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVolumeAttributeRequest.IsSetAutoEnableIO"> <summary> Checks if AutoEnableIO property is set </summary> <returns>true if AutoEnableIO property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVolumeAttributeRequest.WithAutoEnableIO(System.Boolean)"> <summary> Sets whether to auto-enable the I/O operations on the volume. </summary> <param name="autoEnableIO">The new AutoEnableIO value</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.ModifyVolumeAttributeRequest.VolumeId"> <summary> The volume against which to make the modify call. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVolumeAttributeRequest.AutoEnableIO"> <summary> Whether to auto-enable the I/O operations on the volume. </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVolumeAttributeResponse"> <summary> Modify Volume Attribute response. </summary> </member> <member name="M:Amazon.EC2.Model.ModifyVolumeAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVolumeAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ModifyVolumeAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ModifyVolumeAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.Monitoring"> <summary> Monitoring configuration. </summary> </member> <member name="M:Amazon.EC2.Model.Monitoring.WithMonitoringState(System.String)"> <summary> Sets the state of monitoring for the instance. </summary> <param name="monitoringState">State of monitoring for the instance. Valid Values: monitoring-enabled (enabled) | monitoring-pending (pending) | monitoring-disabled (disabled) </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Monitoring.IsSetMonitoringState"> <summary> Checks if MonitoringState property is set </summary> <returns>true if MonitoringState property is set</returns> </member> <member name="P:Amazon.EC2.Model.Monitoring.MonitoringState"> <summary> State of monitoring for the instance. Valid Values: monitoring-enabled (enabled) | monitoring-pending (pending) | monitoring-disabled (disabled) </summary> </member> <member name="T:Amazon.EC2.Model.MonitoringSpecification"> <summary> Whether to enable monitoring for the Spot Instance. </summary> </member> <member name="M:Amazon.EC2.Model.MonitoringSpecification.WithEnabled(System.Boolean)"> <summary> Sets whether to enable monitoring for the Spot instance. </summary> <param name="enabled">Enable monitoring for the Spot instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.MonitoringSpecification.IsSetEnabled"> <summary> Checks if Enabled property is set </summary> <returns>true if Enabled property is set</returns> </member> <member name="P:Amazon.EC2.Model.MonitoringSpecification.Enabled"> <summary> Whether to enable monitoring for the Spot instance. </summary> </member> <member name="T:Amazon.EC2.Model.MonitorInstancesRequest"> <summary> Enables monitoring for a running instance. </summary> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesRequest.WithInstanceId(System.String[])"> <summary> Sets the instance ID. </summary> <param name="list">Instance ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.MonitorInstancesRequest.InstanceId"> <summary> Instance ID. </summary> </member> <member name="T:Amazon.EC2.Model.MonitorInstancesResponse"> <summary> Monitor Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesResponse.IsSetMonitorInstancesResult"> <summary> Checks if MonitorInstancesResult property is set </summary> <returns>true if MonitorInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.MonitorInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.MonitorInstancesResponse.MonitorInstancesResult"> <summary> Gets and sets the MonitorInstancesResult property. Monitor Instances Result </summary> </member> <member name="T:Amazon.EC2.Model.MonitorInstancesResult"> <summary> Monitor Instances Result </summary> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesResult.IsSetInstanceMonitoring"> <summary> Checks if InstanceMonitoring property is set </summary> <returns>true if InstanceMonitoring property is set</returns> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.MonitorInstancesResult.InstanceMonitoring"> <summary> Gets and sets the InstanceMonitoring property. Instance monitoring information </summary> </member> <member name="T:Amazon.EC2.Model.NetworkAcl"> <summary> Network ACL description. </summary> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.WithNetworkAclId(System.String)"> <summary> Sets the network ACL's ID. </summary> <param name="networkAclId">The network ACL's ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.WithVpcId(System.String)"> <summary> Sets the ID of the VPC the network ACL is in. </summary> <param name="vpcId">The ID of the VPC the network ACL is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.WithDefault(System.Boolean)"> <summary> Sets whether this is the default network ACL in the VPC. </summary> <param name="isDefault">Whether this is the default network ACL in the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.IsSetDefault"> <summary> Checks if Default property is set </summary> <returns>true if Default property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.WithEntries(Amazon.EC2.Model.NetworkAclEntry[])"> <summary> Sets the entries (rules) in the network ACL. </summary> <param name="list">A list of entries (rules) in the network ACL.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.IsSetEntries"> <summary> Checks if Entries property is set </summary> <returns>true if Entries property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.WithAssociations(Amazon.EC2.Model.NetworkAclAssociation[])"> <summary> Sets the associations between the network ACL and one or more subnets. </summary> <param name="list">A list of associations between the network ACL and one or more subnets.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.IsSetAssociations"> <summary> Checks if Associations property is set </summary> <returns>true if Associations property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags for the NetworkAcl. </summary> <param name="list">A list of tags for the NetworkAcl.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAcl.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.NetworkAclId"> <summary> The network ACL's ID. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.VpcId"> <summary> The ID of the VPC the network ACL is in. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.Default"> <summary> Whether this is the default network ACL in the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.Entries"> <summary> A list of entries (rules) in the network ACL. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.Associations"> <summary> A list of associations between the network ACL and one or more subnets. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.Tag"> <summary> A list of tags for the NetworkAcl. </summary> </member> <member name="T:Amazon.EC2.Model.NetworkAclAssociation"> <summary> Network ACL association. </summary> </member> <member name="M:Amazon.EC2.Model.NetworkAclAssociation.WithNetworkAclAssociationId(System.String)"> <summary> Sets an identifier representing the association between a network ACL and a subnet. </summary> <param name="networkAclAssociationId">An identifier representing the association between a network ACL and a subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclAssociation.IsSetNetworkAclAssociationId"> <summary> Checks if NetworkAclAssociationId property is set </summary> <returns>true if NetworkAclAssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclAssociation.WithNetworkAclId(System.String)"> <summary> Sets the ID of the network ACL in the association. </summary> <param name="networkAclId">The ID of the network ACL in the association.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclAssociation.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclAssociation.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet in the association. </summary> <param name="subnetId">The ID of the subnet in the association.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclAssociation.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkAclAssociation.NetworkAclAssociationId"> <summary> An identifier representing the association between a network ACL and a subnet. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclAssociation.NetworkAclId"> <summary> The ID of the network ACL in the association. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclAssociation.SubnetId"> <summary> The ID of the subnet in the association. </summary> </member> <member name="T:Amazon.EC2.Model.NetworkAclEntry"> <summary> Individual network ACL. </summary> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.WithRuleNumber(System.Decimal)"> <summary> Sets the rule number for the entry. </summary> <param name="ruleNumber">Specific rule number for the entry. ACL entries are processed in ascending order by rule number.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.IsSetRuleNumber"> <summary> Checks if RuleNumber property is set </summary> <returns>true if RuleNumber property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.WithProtocol(System.String)"> <summary> Sets the IP protocol for the ACL. </summary> <param name="protocol">IP protocol. For a list of protocol numbers and names, go to Protocol Numbers. Valid Values: tcp | udp | icmp or an IP protocol number.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.IsSetProtocol"> <summary> Checks if Protocol property is set </summary> <returns>true if Protocol property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.WithRuleAction(System.String)"> <summary> Sets whether to allow or deny the traffic that matches the rule. </summary> <param name="ruleAction">Whether to allow or deny the traffic that matches the rule. Valid Values: allow | deny</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.IsSetRuleAction"> <summary> Checks if RuleAction property is set </summary> <returns>true if RuleAction property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.WithEgress(System.Boolean)"> <summary> Sets whether this is an egress rule (rule is applied to traffic leaving the subnet). </summary> <param name="egress">Boolean flag to indicate an egress rule (rule is applied to traffic leaving the subnet). Value of true indicates egress.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.IsSetEgress"> <summary> Checks if Egress property is set </summary> <returns>true if Egress property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.WithCidrBlock(System.String)"> <summary> Sets the network range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). </summary> <param name="cidrBlock">The network range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.IsSetCidrBlock"> <summary> Checks if CidrBlock property is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.WithIcmp(Amazon.EC2.Model.Icmp)"> <summary> Sets the ICMP type and code (for the ICMP protocol). </summary> <param name="icmp">For the ICMP protocol, this is the ICMP type and code.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.IsSetIcmp"> <summary> Checks if Icmp property is set </summary> <returns>true if Icmp property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.WithPortRange(Amazon.EC2.Model.PortRange)"> <summary> Sets the range of ports the rule applies to (for the TCP or UDP protocols). </summary> <param name="portRange">For the TCP or UDP protocols, the range of ports the rule applies to.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkAclEntry.IsSetPortRange"> <summary> Checks if PortRange property is set </summary> <returns>true if PortRange property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.RuleNumber"> <summary> Rule number for the entry. ACL entries are processed in ascending order by rule number. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.Protocol"> <summary> IP protocol for the ACL. Valid Values: tcp | udp | icmp or an IP protocol number. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.RuleAction"> <summary> Whether to allow or deny the traffic that matches the rule. Valid Values: allow | deny </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.Egress"> <summary> Whether this is an egress rule (rule is applied to traffic leaving the subnet). Value of true indicates egress. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.CidrBlock"> <summary> The network range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.Icmp"> <summary> The ICMP type and code (for the ICMP protocol). </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.PortRange"> <summary> The range of ports the rule applies to (for the TCP or UDP protocols). </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterface"> <summary> Describes a Network Interface </summary> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface. </summary> <param name="networkInterfaceId">The ID of the network interface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet. </summary> <param name="subnetId">The ID of the subnet</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetSubnetId"> <summary> Checks if the SubnetId property is set </summary> <returns>true if the SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithVpcId(System.String)"> <summary> Sets the ID of the VPC. </summary> <param name="vpcId">The ID of the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetVpcId"> <summary> Checks if the VpcId property is set </summary> <returns>true if the VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone of the interface. </summary> <param name="availabilityZone">Availability Zone</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetAvailabilityZone"> <summary> Checks if the AvailabilityZone property is set </summary> <returns>true if the AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithDescription(System.String)"> <summary> Sets the description of the interface. </summary> <param name="description">Description</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>true if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithOwnerId(System.String)"> <summary> Sets the ID of the customer who created the interface. </summary> <param name="ownerId">The ID of the customer who created the interface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetOwnerId"> <summary> Checks if the OwnerId property is set </summary> <returns>true if the OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithRequesterId(System.String)"> <summary> Sets the ID of the entity that launched the instance on your behalf (e.g., AWS Management Console, Auto Scaling, etc.) </summary> <param name="requesterId">ID of the entity that launched the instance on your behalf (e.g., AWS Management Console, Auto Scaling, etc.)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetRequesterId"> <summary> Checks if the RequesterId property is set </summary> <returns>true if the RequesterId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithRequesterManaged(System.Boolean)"> <summary> Sets whether the interface is managed by the requester. </summary> <param name="requesterManaged">Requester Managed flag</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithStatus(System.String)"> <summary> Sets the status of the interface. </summary> <param name="status">"available" or "in-use"</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetStatus"> <summary> Checks if the Status property is set </summary> <returns>true if the Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithMacAddress(System.String)"> <summary> Sets the MAC address of the interface. </summary> <param name="macAddress"></param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetMacAddress"> <summary> Checks if the MacAddress property is set </summary> <returns>true if the MacAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithPrivateIpAddress(System.String)"> <summary> Sets the IP address of the interface within the subnet. </summary> <param name="privateIpAddress">IP address of the interface within the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetPrivateIpAddress"> <summary> Checks if the PrivateIpAddress property is set </summary> <returns>true if the PrivateIpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithPrivateDnsName(System.String)"> <summary> Sets the private DNS name. </summary> <param name="privateDnsName">Private Dns Name</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetPrivateDnsName"> <summary> Checks if the PrivateDnsName property is set </summary> <returns>true if the PrivateDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithSourceDestCheck(System.Boolean)"> <summary> Sets whether traffic to or from the instance is validated. </summary> <param name="sourceDestCheck">Flag indicating whether traffic to or from the instance is validated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetSourceDestCheck"> <summary> Checks if the SourceDestCheck property is set </summary> <returns>true if the SourceDestCheck property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithGroupId(System.String[])"> <summary> Sets the security group IDs associated with the interface. </summary> <param name="list">A list of security groups the instance is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithGroupName(System.String[])"> <summary> Sets the security group names the instance is in. </summary> <param name="list">A list of security groups the instance is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithAttachment(Amazon.EC2.Model.NetworkInterfaceAttachment)"> <summary> Sets the network interface attachment. </summary> <param name="attachment">Network Interface Attachment</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetAttachment"> <summary> Checks if the Attachment property is set </summary> <returns>true if the Attachment property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithAssociation(Amazon.EC2.Model.NetworkInterfaceAssociation)"> <summary> Sets the association information for an Elastic IP associated with the network interface. </summary> <param name="association">Network Interface Association</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetAssociation"> <summary> Checks if the Association property is set </summary> <returns>true if the Association property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the resouce tags for this interface. </summary> <param name="list">A list of tags for the NetworkInterface.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.WithPrivateIpAddresses(Amazon.EC2.Model.NetworkInterfacePrivateIpAddress[])"> <summary> Sets the private IP addresses. </summary> <param name="privateIpAddresses">Private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterface.IsSetPrivateIpAddresses"> <summary> Checks if the PrivateIpAddresses property is set </summary> <returns>true if the PrivateIpAddresses property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.NetworkInterfaceId"> <summary> The ID of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.SubnetId"> <summary> The ID of the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.VpcId"> <summary> The ID of the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.AvailabilityZone"> <summary> The Availability Zone of the interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Description"> <summary> The description of the interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.OwnerId"> <summary> The ID of the customer who created the interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.RequesterId"> <summary> ID of the entity that launched the instance on your behalf (e.g., AWS Management Console, Auto Scaling, etc.) </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.RequesterManaged"> <summary> Whether the interface is managed by the requester. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Status"> <summary> The status of the interface. Valid values: "available" | "in-use". </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.MacAddress"> <summary> The MAC address of the interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.PrivateIpAddress"> <summary> IP address of the interface within the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.PrivateDnsName"> <summary> The private DNS name. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.SourceDestCheck"> <summary> Whether traffic to or from the instance is validated. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.GroupId"> <summary> Security group IDs associated with the interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.GroupName"> <summary> A list of security group names the instance is in. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Attachment"> <summary> The network interface attachment. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Association"> <summary> The association information for an Elastic IP associated with the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Tag"> <summary> Resouce tags for this interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.PrivateIpAddresses"> <summary> Private IP addresses. </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterfaceAssociation"> <summary> Network Interface Association </summary> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.WithPublicIp(System.String)"> <summary> Sets the address of the Elastic IP address bound to the network interface. </summary> <param name="publicIp">Public Ip</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.IsSetPublicIp"> <summary> Checks if the PublicIp property is set </summary> <returns>true if the PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.WithPublicDnsName(System.String)"> <summary> Sets the DNS name for the network interface. </summary> <param name="publicDnsName">PublicDnsName</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.IsSetPublicDnsName"> <summary> Checks if the PublicDnsName property is set </summary> <returns>true if the PublicDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.WithIpOwnerId(System.String)"> <summary> Sets the ID of the Elastic IP address owner. </summary> <param name="ipOwnerId">Ip Owner Id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.IsSetIpOwnerId"> <summary> Checks if the IpOwnerId property is set </summary> <returns>true if the IpOwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.WithAllocationId(System.String)"> <summary> Sets the ID representing the allocation of the address for use with Amazon VPC. </summary> <param name="allocationId">Allocation Id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.IsSetAllocationId"> <summary> Checks if the AllocationId property is set </summary> <returns>true if the AllocationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.WithAssociationId(System.String)"> <summary> Sets the association ID corresponding to the VPC Elastic IP Conditional address. </summary> <param name="associationId">Association Id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAssociation.IsSetAssociationId"> <summary> Checks if the AssocationId property is set </summary> <returns>true if the AssociationId property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.PublicIp"> <summary> The address of the Elastic IP address bound to the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.PublicDnsName"> <summary> The DNS name for the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.IpOwnerId"> <summary> The ID of the Elastic IP address owner. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.AllocationId"> <summary> The ID representing the allocation of the address for use with Amazon VPC. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.AssociationId"> <summary> The association ID corresponding to the VPC Elastic IP Conditional address. </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterfaceAttachment"> <summary> Network Interface Attachment </summary> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.WithAttachmentId(System.String)"> <summary> Sets the ID of the network interface attachment. </summary> <param name="attachmentId">Attachment Id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.IsSetAttachmentId"> <summary> Checks if the AttachmentId property is set </summary> <returns>true if the AttachmentId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.WithInstanceId(System.String)"> <summary> Sets the ID of the instance. </summary> <param name="instanceId">Instance ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.IsSetInstanceId"> <summary> Checks if the InstanceId property is set </summary> <returns>true if the InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.WithInstanceOwnerId(System.String)"> <summary> Sets the owner of the instance. </summary> <param name="instanceOwnerId">Instance Owner ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.IsSetInstanceOwnerId"> <summary> Checks if the InstanceOwnerId property is set </summary> <returns>true if the InstanceOwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.WithDeviceIndex(System.Int32)"> <summary> Sets the index of the device for the network interface attachment on the instance. </summary> <param name="deviceIndex">Device Index</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.IsSetDeviceIndex"> <summary> Checks if the DeviceIndex property is set </summary> <returns>true if the DeviceIndex property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.WithStatus(System.String)"> <summary> Sets the status of the network interface attachment. </summary> <param name="status">Status</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.IsSetStatus"> <summary> Checks if the Status property is set </summary> <returns>true if the Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.WithAttachTime(System.String)"> <summary> Sets the time stamp when the attachment initiated. </summary> <param name="attachTime">Attach Time</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.IsSetAttachTime"> <summary> Checks if the AttachTime property is set </summary> <returns>true if the AttachTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.WithDeleteOnTermination(System.Boolean)"> <summary> Sets whether the attachment is deleted on instance termination. </summary> <param name="deleteOnTermination">True if the attachment should be deleted on termination</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttachment.IsSetDeleteOnTermination"> <summary> Checks if the DeleteOnTermination property is set </summary> <returns>true if the DeleteOnTermination property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.AttachmentId"> <summary> The ID of the network interface attachment. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.InstanceId"> <summary> The ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.InstanceOwnerId"> <summary> The owner of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.DeviceIndex"> <summary> The index of the device for the network interface attachment on the instance. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.Status"> <summary> The status of the network interface attachment. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.AttachTime"> <summary> The time stamp when the attachment initiated. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.DeleteOnTermination"> <summary> Whether the attachment is deleted on instance termination. </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterfaceAttribute"> <summary> Network Interface Attribute </summary> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface. </summary> <param name="networkInterfaceId">The ID of the network interface</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.WithDescription(System.String)"> <summary> Sets the description of the network interface. </summary> <param name="description">Description of the network interface</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>true if the Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.WithSourceDestCheck(System.Boolean)"> <summary> Sets whether source/destination checking is enabled on the instance. </summary> <param name="sourceDestCheck">Flag indicating whether traffic to or from the instance is validated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.IsSetSourceDestCheck"> <summary> Checks if the SourceDestCheck property is set </summary> <returns>true if the SourceDestCheck property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.WithGroupId(System.String[])"> <summary> Sets the IDs of security groups the interface is in. </summary> <param name="list">ID of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.WithGroupName(System.String[])"> <summary> Sets the names of security groups the interface is in. </summary> <param name="list">Name of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.WithAttachment(Amazon.EC2.Model.NetworkInterfaceAttachment)"> <summary> Sets the interface attachment. </summary> <param name="attachment">Network Interface Attachment</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfaceAttribute.IsSetAttachment"> <summary> Checks if the Attachment property is set </summary> <returns>true if the Attachment property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttribute.NetworkInterfaceId"> <summary> The ID of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttribute.Description"> <summary> Description of the network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttribute.SourceDestCheck"> <summary> Whether source/destination checking is enabled on the instance. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttribute.GroupId"> <summary> The IDs of security groups the interface is in. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttribute.GroupName"> <summary> The names of security groups the interface is in. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttribute.Attachment"> <summary> The interface attachment. </summary> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.WithIpAddress(System.String)"> <summary> Private IP address. </summary> <param name="ipAddress">Private IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.IsSetIpAddress"> <summary> Checks if the IpAddress property is set </summary> <returns>true if the IpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.WithPrivateDnsName(System.String)"> <summary> Sets the private DNS name. </summary> <param name="privateDnsName">Private DNS name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.IsSetPrivateDnsName"> <summary> Checks if the PrivateDnsName property is set </summary> <returns>true if the PrivateDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.WithPrimary(System.Boolean)"> <summary> Sets whether this is a primary IP. </summary> <param name="primary">Whether this is a primary IP.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.IsSetPrimary"> <summary> Checks if the Primary property is set </summary> <returns>true if the Primary property is set</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.WithAssociation(Amazon.EC2.Model.NetworkInterfaceAssociation)"> <summary> Sets the Instance Network Interface Association. </summary> <param name="association">Instance Network Interface Association.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.IsSetAssociation"> <summary> Checks if the Association property is set </summary> <returns>true if the Association property is set</returns> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.IpAddress"> <summary> Private IP address. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.PrivateDnsName"> <summary> Private DNS name. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.Primary"> <summary> Whether this is a primary IP. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.Association"> <summary> Instance Network Interface Association. </summary> </member> <member name="T:Amazon.EC2.Model.PasswordData"> <summary> Password Data </summary> </member> <member name="M:Amazon.EC2.Model.PasswordData.WithInstanceId(System.String)"> <summary> Sets the ID of the instance. </summary> <param name="instanceId">The ID of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PasswordData.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.PasswordData.WithTimestamp(System.String)"> <summary> Sets the time the data was last updated. </summary> <param name="timestamp">The time the data was last updated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PasswordData.IsSetTimestamp"> <summary> Checks if Timestamp property is set </summary> <returns>true if Timestamp property is set</returns> </member> <member name="M:Amazon.EC2.Model.PasswordData.WithData(System.String)"> <summary> Sets the password of the instance. </summary> <param name="data">The password of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PasswordData.IsSetData"> <summary> Checks if Data property is set </summary> <returns>true if Data property is set</returns> </member> <member name="P:Amazon.EC2.Model.PasswordData.InstanceId"> <summary> The ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.PasswordData.Timestamp"> <summary> The time the data was last updated. </summary> </member> <member name="P:Amazon.EC2.Model.PasswordData.Data"> <summary> The password of the instance. </summary> </member> <member name="T:Amazon.EC2.Model.Placement"> <summary> Placement constraints. </summary> </member> <member name="M:Amazon.EC2.Model.Placement.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone of the instance. </summary> <param name="availabilityZone">Availability Zones for launching the instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Placement.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.Placement.WithGroupName(System.String)"> <summary> Sets the name of the placement group the instance is in. </summary> <param name="groupName">The name of a PlacementGroup.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Placement.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.Placement.IsSetTenancy"> <summary> Checks if Tenancy property is set </summary> <returns>true if Tenancy property is set</returns> </member> <member name="M:Amazon.EC2.Model.Placement.WithTenancy(System.String)"> <summary> Sets the tenancy of the instance. Valid Values: default | dedicated </summary> <param name="tenancy">The tenancy of the instance.</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.Placement.AvailabilityZone"> <summary> The Availability Zone of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.Placement.GroupName"> <summary> The name of the placement group the instance is in. </summary> </member> <member name="P:Amazon.EC2.Model.Placement.Tenancy"> <summary> The tenancy of the instance. Valid Values: default | dedicated </summary> </member> <member name="T:Amazon.EC2.Model.PlacementGroupInfo"> <summary> A placement group into which multiple Amazon EC2 instances can be launched. </summary> <remarks> A placement group ensures that Amazon EC2 instances are physically located close enough to support HPC features, such as higher IO network connections between instances in the group. </remarks> </member> <member name="M:Amazon.EC2.Model.PlacementGroupInfo.WithGroupName(System.String)"> <summary> Sets the name of the PlacementGroup. </summary> <param name="groupName">The name of the PlacementGroup.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PlacementGroupInfo.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.PlacementGroupInfo.WithStrategy(System.String)"> <summary> Sets the strategy to use when allocating Amazon EC2 instances for the PlacementGroup. </summary> <param name="strategy">The strategy to use when allocating Amazon EC2 instances for the PlacementGroup.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PlacementGroupInfo.IsSetStrategy"> <summary> Checks if Strategy property is set </summary> <returns>true if Strategy property is set</returns> </member> <member name="M:Amazon.EC2.Model.PlacementGroupInfo.WithState(System.String)"> <summary> Sets the state of the PlacementGroup. </summary> <param name="state">The state of this PlacementGroup.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PlacementGroupInfo.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="P:Amazon.EC2.Model.PlacementGroupInfo.GroupName"> <summary> The name of the PlacementGroup. </summary> </member> <member name="P:Amazon.EC2.Model.PlacementGroupInfo.Strategy"> <summary> The strategy to use when allocating Amazon EC2 instances for the PlacementGroup. </summary> </member> <member name="P:Amazon.EC2.Model.PlacementGroupInfo.State"> <summary> The state of the PlacementGroup. </summary> </member> <member name="T:Amazon.EC2.Model.PortRange"> <summary> Port range. </summary> </member> <member name="M:Amazon.EC2.Model.PortRange.WithFrom(System.Decimal)"> <summary> Sets the first port in the range. A value of -1 indicates all ports. </summary> <param name="from">The first port in the range. A value of -1 indicates all ports.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PortRange.IsSetFrom"> <summary> Checks if From property is set </summary> <returns>true if From property is set</returns> </member> <member name="M:Amazon.EC2.Model.PortRange.WithTo(System.Decimal)"> <summary> Sets the last port in the range. A value of -1 indicates all ports </summary> <param name="to">The last port in the range. A value of -1 indicates all ports</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PortRange.IsSetTo"> <summary> Checks if To property is set </summary> <returns>true if To property is set</returns> </member> <member name="P:Amazon.EC2.Model.PortRange.From"> <summary> The first port in the range. A value of -1 indicates all ports. </summary> </member> <member name="P:Amazon.EC2.Model.PortRange.To"> <summary> The last port in the range. A value of -1 indicates all ports </summary> </member> <member name="T:Amazon.EC2.Model.PrivateIpAddress"> <summary> Private Ip Address </summary> </member> <member name="M:Amazon.EC2.Model.PrivateIpAddress.WithIpAddress(System.String)"> <summary> Sets the private IP address. </summary> <param name="ipAddress">Private IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PrivateIpAddress.IsSetIpAddress"> <summary> Checks if the IpAddress property is set </summary> <returns>true if the IpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.PrivateIpAddress.WithPrimary(System.Boolean)"> <summary> Sets whether this is a primary IP. </summary> <param name="primary">Whether this is a primary IP.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PrivateIpAddress.IsSetPrimary"> <summary> Checks if the Primary property is set </summary> <returns>true if the Primary property is set</returns> </member> <member name="P:Amazon.EC2.Model.PrivateIpAddress.IpAddress"> <summary> Private IP address. </summary> </member> <member name="P:Amazon.EC2.Model.PrivateIpAddress.Primary"> <summary> Whether this is a primary IP. </summary> </member> <member name="T:Amazon.EC2.Model.PriceSchedule"> <summary> Price Schedule </summary> </member> <member name="M:Amazon.EC2.Model.PriceSchedule.IsSetTerm"> <summary> Checks if the Term property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.PriceSchedule.IsSetPrice"> <summary> Checks if the Price property is set. </summary> <returns>True if the property is set.</returns> </member> <member name="M:Amazon.EC2.Model.PriceSchedule.IsSetCurrencyCode"> <summary> Checks if the CurrencyCode property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.PriceSchedule.IsSetActive"> <summary> Checks if the Active property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.Term"> <summary> The number of months remaining in the reservation. </summary> <remarks> For example, 2 is the second to the last month before the capacity reservation expires. </remarks> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.Price"> <summary> The fixed price for the term. </summary> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.CurrencyCode"> <summary> The currency for transacting the Reserved Instance resale. </summary> <remarks>Possible values - "USD"</remarks> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.Active"> <summary> Whether the current price schedule is active. </summary> <remarks> A specific price schedule is always in effect, but only one price schedule can be active at any time. For example, you have a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 5 will be active during months 5, 4, and 3, then schedule 2 will be active for months 2 and 1. </remarks> </member> <member name="T:Amazon.EC2.Model.PricingSchedule"> <summary> Pricing Schedule </summary> </member> <member name="M:Amazon.EC2.Model.PricingSchedule.WithTerm(System.Decimal)"> <summary> Sets the number of months remaining in the reservation. </summary> <param name="term">Number of months remaining</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PricingSchedule.IsSetTerm"> <summary> Checks if the Term property is set </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.PricingSchedule.WithPrice(System.Decimal)"> <summary> Sets the fixed price for the term. </summary> <param name="price">Fixed price, up to 3 decimal position</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PricingSchedule.IsSetPrice"> <summary> Checks if the Price property is set. </summary> <returns>True if the property is set.</returns> </member> <member name="M:Amazon.EC2.Model.PricingSchedule.WithCurrencyCode(System.String)"> <summary> Sets the currency code for the Price property. </summary> <param name="currencyCode">Currency code</param> <returns>this instance</returns> <remarks>Possible values "USD"</remarks> </member> <member name="M:Amazon.EC2.Model.PricingSchedule.IsSetCurrencyCode"> <summary> Checks if the CurrencyCode property is set </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.PricingSchedule.Term"> <summary> The number of months remaining in the reservation. </summary> <remarks> For example, 2 is the second to the last month before the capacity reservation expires. </remarks> </member> <member name="P:Amazon.EC2.Model.PricingSchedule.Price"> <summary> The fixed price for the term. </summary> </member> <member name="P:Amazon.EC2.Model.PricingSchedule.CurrencyCode"> <summary> Currency code for the Price property. </summary> <remarks>Possible values - "USD"</remarks> </member> <member name="T:Amazon.EC2.Model.PricingDetails"> <summary> Pricing Details </summary> </member> <member name="M:Amazon.EC2.Model.PricingDetails.IsSetPrice"> <summary> Checks if the Price property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.PricingDetails.IsSetCount"> <summary> Checks if the Count property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.PricingDetails.Price"> <summary> Price per instance. </summary> </member> <member name="P:Amazon.EC2.Model.PricingDetails.Count"> <summary> Number of instances available for the price. </summary> </member> <member name="T:Amazon.EC2.Model.ProductCode"> <summary> Product Code </summary> </member> <member name="M:Amazon.EC2.Model.ProductCode.WithProductCodeId(System.String)"> <summary> Sets the product code ID. </summary> <param name="productCodeId">The product code</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ProductCode.IsSetProductCodeId"> <summary> Checks if ProductCodeId property is set </summary> <returns>true if ProductCodeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ProductCode.WithProductType(System.String)"> <summary> Sets the product code type. </summary> <param name="productType">The product type</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ProductCode.IsSetProductType"> <summary> Checks if ProductType property is set </summary> <returns>true if ProductType property is set</returns> </member> <member name="P:Amazon.EC2.Model.ProductCode.ProductCodeId"> <summary> The product code ID. </summary> </member> <member name="P:Amazon.EC2.Model.ProductCode.ProductType"> <summary> The product code type. </summary> </member> <member name="T:Amazon.EC2.Model.PropagatedRoute"> <summary> Propagated Route </summary> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.WithDestinationCidrBlock(System.String)"> <summary> Sets the CIDR block associated with local subnet of the customer data center. </summary> <param name="destinationCidrBlock">CIDR</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.IsSetDestinationCidrBlock"> <summary> Checks if the DestinationCidrBlock property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.WithGatewayId(System.String)"> <summary> Sets the ID of the Virtual Private Gateway. </summary> <param name="gatewayId">Gateway Id</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.IsSetGatewayId"> <summary> Checks if the GatewayId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.WithStatus(System.String)"> <summary> Sets the status of the propagated route. </summary> <param name="status">Route status</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.IsSetStatus"> <summary> Checks if the Status property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.WithSourceId(System.String)"> <summary> Sets the SourceId property. </summary> <param name="sourceId">DOCS_TODO</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.PropagatedRoute.IsSetSourceId"> <summary> Checks if the SourceId property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.PropagatedRoute.DestinationCidrBlock"> <summary> The CIDR block associated with local subnet of the customer data center. </summary> </member> <member name="P:Amazon.EC2.Model.PropagatedRoute.GatewayId"> <summary> The ID of the Virtual Private Gateway. </summary> </member> <member name="P:Amazon.EC2.Model.PropagatedRoute.Status"> <summary> The status of the propagated route. </summary> </member> <member name="P:Amazon.EC2.Model.PropagatedRoute.SourceId"> <summary> DOCS_TODO </summary> </member> <member name="T:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest"> <summary> Purchases a Reserved Instance for use with your account. </summary> <remarks> With Amazon EC2 Reserved Instances, you purchase the right to launch Amazon EC2 instances for a period of time (without getting insufficient capacity errors) and pay a lower usage rate for the actual time used. For more information about Reserved Instances, go to the Amazon Elastic Compute Cloud Developer Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.WithReservedInstancesOfferingId(System.String)"> <summary> Sets the offering ID of the Reserved Instance to purchase. </summary> <param name="reservedInstancesOfferingId">The offering ID of the Reserved Instance to purchase.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.IsSetReservedInstancesOfferingId"> <summary> Checks if ReservedInstancesOfferingId property is set </summary> <returns>true if ReservedInstancesOfferingId property is set</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.WithInstanceCount(System.String)"> <summary> Sets the number of Reserved Instances to purchase. </summary> <param name="instanceCount">The number of Reserved Instances to purchase. Default: None</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.IsSetInstanceCount"> <summary> Checks if InstanceCount property is set </summary> <returns>true if InstanceCount property is set</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.WithLimitPrice(Amazon.EC2.Model.ReservedInstanceLimitPrice)"> <summary> Sets the limiting price for Reserved Instance Marketplace offerings. </summary> <param name="limitPrice">Price limit</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.IsSetLimitPrice"> <summary> Checks if the LimitPrice property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.ReservedInstancesOfferingId"> <summary> The offering ID of the Reserved Instance to purchase. </summary> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.InstanceCount"> <summary> The number of Reserved Instances to purchase. Default: None </summary> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.LimitPrice"> <summary> The limiting price for Reserved Instance Marketplace offerings. This limits the total order and ensures that the Reserved Instances are not purchased at unexpected prices. </summary> </member> <member name="T:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse"> <summary> Purchase Reserved Instances Offering Response </summary> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse.IsSetPurchaseReservedInstancesOfferingResult"> <summary> Checks if PurchaseReservedInstancesOfferingResult property is set </summary> <returns>true if PurchaseReservedInstancesOfferingResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse.PurchaseReservedInstancesOfferingResult"> <summary> Gets and sets the PurchaseReservedInstancesOfferingResult property. Purchase Reserved Instances Offering Result </summary> </member> <member name="T:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResult"> <summary> Purchase Reserved Instances Offering Result </summary> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResult.IsSetReservedInstancesId"> <summary> Checks if ReservedInstancesId property is set </summary> <returns>true if ReservedInstancesId property is set</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResult.ReservedInstancesId"> <summary> Gets and sets the ReservedInstancesId property. The IDs of the purchased Reserved Instances. </summary> </member> <member name="T:Amazon.EC2.Model.RebootInstancesRequest"> <summary> Container for the parameters to the RebootInstances operation. <para>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> <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> </member> <member name="M:Amazon.EC2.Model.RebootInstancesRequest.WithInstanceId(System.String[])"> <summary> Sets instance IDs. </summary> <param name="list">One or more instance IDs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RebootInstancesRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.RebootInstancesRequest.InstanceId"> <summary> One or more instance IDs. </summary> </member> <member name="T:Amazon.EC2.Model.RebootInstancesResponse"> <summary> Reboot Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.RebootInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.RebootInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RebootInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RebootInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.RecurringCharges"> <summary> The frequency and the amount of recurring charges. </summary> </member> <member name="M:Amazon.EC2.Model.RecurringCharges.IsSetFrequency"> <summary> Checks if Frequency property is set </summary> <returns>true if Frequency property is set</returns> </member> <member name="M:Amazon.EC2.Model.RecurringCharges.IsSetAmount"> <summary> Checks if Amount property is set </summary> <returns>true if Amount property is set</returns> </member> <member name="P:Amazon.EC2.Model.RecurringCharges.Frequency"> <summary> The frequency of the recurring charge. Valid values: Hourly, Monthly. </summary> </member> <member name="P:Amazon.EC2.Model.RecurringCharges.Amount"> <summary> The amount of the recurring charge. </summary> </member> <member name="T:Amazon.EC2.Model.Region"> <summary> Region </summary> </member> <member name="M:Amazon.EC2.Model.Region.WithRegionName(System.String)"> <summary> Sets the name of the region. </summary> <param name="regionName">Name of the region.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Region.IsSetRegionName"> <summary> Checks if RegionName property is set </summary> <returns>true if RegionName property is set</returns> </member> <member name="M:Amazon.EC2.Model.Region.WithEndpoint(System.String)"> <summary> Sets the region service endpoint. </summary> <param name="endpoint">Region service endpoint.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Region.IsSetEndpoint"> <summary> Checks if Endpoint property is set </summary> <returns>true if Endpoint property is set</returns> </member> <member name="P:Amazon.EC2.Model.Region.RegionName"> <summary> Name of the region. </summary> </member> <member name="P:Amazon.EC2.Model.Region.Endpoint"> <summary> Region service endpoint. </summary> </member> <member name="T:Amazon.EC2.Model.RegisterImageRequest"> <summary> Registers an AMI with Amazon EC2. </summary> <remarks> Images must be registered before they can be launched. To launch instances, use the RunInstances operation. Each AMI is associated with an unique ID which is provided by the Amazon EC2 service through the RegisterImage operation. During registration, Amazon EC2 retrieves the specified image manifest from Amazon S3 and verifies that the image is owned by the user registering the image. The image manifest is retrieved once and stored within the Amazon EC2. Any modifications to an image in Amazon S3 invalidates this registration. If you make changes to an image, deregister the previous image and register the new image. To deregister an image, use the DeregisterImage operation. </remarks> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithImageLocation(System.String)"> <summary> Sets the full path to your AMI manifest in Amazon S3 storage. </summary> <param name="imageLocation">Full path to your AMI manifest in Amazon S3 storage.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetImageLocation"> <summary> Checks if ImageLocation property is set </summary> <returns>true if ImageLocation property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithName(System.String)"> <summary> Sets the name of the AMI. </summary> <param name="name">The name of the AMI that was provided during image creation.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetName"> <summary> Checks if Name property is set </summary> <returns>true if Name property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithDescription(System.String)"> <summary> Sets the description of the AMI. </summary> <param name="description">The description of the AMI. Must be 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores(_).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithArchitecture(System.String)"> <summary> Sets the architecture of the image. </summary> <param name="architecture">Architecture property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetArchitecture"> <summary> Checks if Architecture property is set </summary> <returns>true if Architecture property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithKernelId(System.String)"> <summary> Sets the ID of the kernel to select. </summary> <param name="kernelId">The ID of the kernel to select.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetKernelId"> <summary> Checks if KernelId property is set </summary> <returns>true if KernelId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithRamdiskId(System.String)"> <summary> Sets the ID of the RAM disk to select. </summary> <param name="ramdiskId">The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetRamdiskId"> <summary> Checks if RamdiskId property is set </summary> <returns>true if RamdiskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithRootDeviceName(System.String)"> <summary> Sets the root device name (e.g., /dev/sda1). </summary> <param name="rootDeviceName">The root device name (e.g., /dev/sda1).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetRootDeviceName"> <summary> Checks if RootDeviceName property is set </summary> <returns>true if RootDeviceName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.WithBlockDeviceMapping(Amazon.EC2.Model.BlockDeviceMapping[])"> <summary> Sets the device names exposed to the instance (for example, /dev/sdh or xvdh). </summary> <param name="list">BlockDeviceMapping property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.ImageLocation"> <summary> Full path to your AMI manifest in Amazon S3 storage. </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.Name"> <summary> The name of the AMI that was provided during image creation. </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.Description"> <summary> The description of the AMI. </summary> <remarks> Must be 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores(_). </remarks> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.Architecture"> <summary> The architecture of the image. Valid values: i386 | x86_64 </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.KernelId"> <summary> The ID of the kernel to select. </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.RamdiskId"> <summary> The ID of the RAM disk to select. </summary> <remarks> Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk. </remarks> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.RootDeviceName"> <summary> The root device name (e.g., /dev/sda1). </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.BlockDeviceMapping"> <summary> The device names exposed to the instance (for example, /dev/sdh or xvdh). </summary> </member> <member name="T:Amazon.EC2.Model.RegisterImageResponse"> <summary> Register Image Response </summary> </member> <member name="M:Amazon.EC2.Model.RegisterImageResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageResponse.IsSetRegisterImageResult"> <summary> Checks if RegisterImageResult property is set </summary> <returns>true if RegisterImageResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RegisterImageResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageResponse.RegisterImageResult"> <summary> Gets and sets the RegisterImageResult property. Register Image Result </summary> </member> <member name="T:Amazon.EC2.Model.RegisterImageResult"> <summary> Register Image Result </summary> </member> <member name="M:Amazon.EC2.Model.RegisterImageResult.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RegisterImageResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RegisterImageResult.ImageId"> <summary> Gets and sets the ImageId property. Unique ID of the newly registered machine image. </summary> </member> <member name="T:Amazon.EC2.Model.ReleaseAddressRequest"> <summary> Releases an elastic IP address associated with your account. </summary> <remarks> If you run this operation on an elastic IP address that is already released, the address might be assigned to another account which will cause Amazon EC2 to return an error. Releasing an IP address automatically disassociates it from any instance with which it is associated. To disassociate an IP address without releasing it, use the DisassociateAddress operation. After releasing an elastic IP address, it is released to the IP // address pool and might no longer be available to your account. Make sure to update your DNS records and any servers or devices that communicate with the address. </remarks> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressRequest.WithPublicIp(System.String)"> <summary> Sets the IP address that you are releasing from your account. </summary> <param name="publicIp">The IP address that you are releasing from your account.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressRequest.IsSetPublicIp"> <summary> Checks if PublicIp property is set </summary> <returns>true if PublicIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressRequest.WithAllocationId(System.String)"> <summary> Sets the address allocation ID. </summary> <param name="allocationId">The allocation ID that AWS provided when you allocated the address for use with Amazon VPC. Type: String Default: None Condition: Required for VPC elastic IP addresses</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressRequest.IsSetAllocationId"> <summary> Checks if AllocationId property is set </summary> <returns>true if AllocationId property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReleaseAddressRequest.PublicIp"> <summary> The IP address that you are releasing from your account. </summary> </member> <member name="P:Amazon.EC2.Model.ReleaseAddressRequest.AllocationId"> <summary> Address allocation ID. This value was provided when you allocated the address for use with Amazon VPC. </summary> </member> <member name="T:Amazon.EC2.Model.ReleaseAddressResponse"> <summary> Release Address Response </summary> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReleaseAddressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest"> <summary> Changes which network ACL a subnet is associated with. </summary> <remarks> By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.WithAssociationId(System.String)"> <summary> Sets the ID representing the current association between the original network ACL and the subnet. </summary> <param name="associationId">The ID representing the current association between the original network ACL and the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.IsSetAssociationId"> <summary> Checks if AssociationId property is set </summary> <returns>true if AssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.WithNetworkAclId(System.String)"> <summary> Sets the ID of the new ACL to associate with the subnet. </summary> <param name="networkAclId">The ID of the new ACL to associate with the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.AssociationId"> <summary> The ID representing the current association between the original network ACL and the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.NetworkAclId"> <summary> The ID of the new ACL to associate with the subnet. </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse"> <summary> The Response for the ReplaceNetworkAclAssociation operation. </summary> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse.IsSetReplaceNetworkAclAssociationResult"> <summary> Checks if ReplaceNetworkAclAssociationResult property is set </summary> <returns>true if ReplaceNetworkAclAssociationResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse.ReplaceNetworkAclAssociationResult"> <summary> Gets and sets the ReplaceNetworkAclAssociationResult property. ReplaceNetworkAclAssociation Result </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclAssociationResult"> <summary> ReplaceNetworkAclAssociation Result </summary> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationResult.IsSetNewAssociationId"> <summary> Checks if NewAssociationId property is set </summary> <returns>true if NewAssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclAssociationResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationResult.NewAssociationId"> <summary> Gets and sets the NewAssociationId property. The ID representing the new association. </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest"> <summary> Replaces an entry (i.e., rule) in a network ACL. </summary> <remarks> For more information about network ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithNetworkAclId(System.String)"> <summary> Sets the ID of the ACL where the entry will be replaced. </summary> <param name="networkAclId">ID of the ACL where the entry will be replaced.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetNetworkAclId"> <summary> Checks if NetworkAclId property is set </summary> <returns>true if NetworkAclId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithRuleNumber(System.Decimal)"> <summary> Sets the rule number of the entry to replace. </summary> <param name="ruleNumber">Rule number of the entry to replace.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetRuleNumber"> <summary> Checks if RuleNumber property is set </summary> <returns>true if RuleNumber property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithProtocol(System.String)"> <summary> Sets the IP protocol the rule applies to. </summary> <param name="protocol">IP protocol the rule applies to. Valid Values: tcp | udp | icmp or an IP protocol number.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetProtocol"> <summary> Checks if Protocol property is set </summary> <returns>true if Protocol property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithRuleAction(System.String)"> <summary> Sets whether to allow or deny traffic that matches the rule. </summary> <param name="ruleAction">Whether to allow or deny traffic that matches the rule. Valid Values: allow | deny</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetRuleAction"> <summary> Checks if RuleAction property is set </summary> <returns>true if RuleAction property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithEgress(System.Boolean)"> <summary> Sets whether this rule applies to egress traffic from the subnet (true) or ingress traffic (false). </summary> <param name="egress">Whether this rule applies to egress traffic from the No subnet (true) or ingress traffic (false).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetEgress"> <summary> Checks if Egress property is set </summary> <returns>true if Egress property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithCidrBlock(System.String)"> <summary> Sets the CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). </summary> <param name="cidrBlock">The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetCidrBlock"> <summary> Checks if CidrBlock property is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithIcmp(Amazon.EC2.Model.Icmp)"> <summary> Sets the ICMP type and code for the ICMP protocol. </summary> <param name="icmp">For the ICMP protocol, this is the ICMP type and code.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetIcmp"> <summary> Checks if Icmp property is set </summary> <returns>true if Icmp property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.WithPortRange(Amazon.EC2.Model.PortRange)"> <summary> Sets the range of ports the rule applies to for the TCP or UDP protocols. </summary> <param name="portRange">For the TCP or UDP protocols, the range of ports the rule applies to.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IsSetPortRange"> <summary> Checks if PortRange property is set </summary> <returns>true if PortRange property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.NetworkAclId"> <summary> ID of the ACL where the entry will be replaced. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.RuleNumber"> <summary> Rule number of the entry to replace. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.Protocol"> <summary> IP protocol the rule applies to. Valid Values: tcp | udp | icmp or an IP protocol number. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.RuleAction"> <summary> Whether to allow or deny traffic that matches the rule. Valid Values: allow | deny </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.Egress"> <summary> Whether this rule applies to egress traffic from the subnet (true) or ingress traffic (false). </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.CidrBlock"> <summary> The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24). </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.Icmp"> <summary> The ICMP type and code for the ICMP protocol. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.PortRange"> <summary> The range of ports the rule applies to for the TCP or UDP protocols. </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclEntryResponse"> <summary> The Response for the ReplaceNetworkAclEntry operation. </summary> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceNetworkAclEntryResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteRequest"> <summary> Replaces an existing route within a route table in a VPC. </summary> <remarks> For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.WithRouteTableId(System.String)"> <summary> Sets the ID of the route table where the route will be replaced. </summary> <param name="routeTableId">The ID of the route table where the route will be replaced.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.WithDestinationCidrBlock(System.String)"> <summary> Sets the CIDR address block used for the destination match. </summary> <param name="destinationCidrBlock">The CIDR address block used for the destination match. For example: 0.0.0.0/0.The value you provide must match the CIDR of an existing route in the table.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.IsSetDestinationCidrBlock"> <summary> Checks if DestinationCidrBlock property is set </summary> <returns>true if DestinationCidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.WithGatewayId(System.String)"> <summary> Sets the ID of a gateway attached to your VPC. </summary> <param name="gatewayId">The ID of a gateway attached to your VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.IsSetGatewayId"> <summary> Checks if GatewayId property is set </summary> <returns>true if GatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.WithInstanceId(System.String)"> <summary> Sets the ID of a NAT instance in your VPC. </summary> <param name="instanceId">The ID of a NAT instance in your VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the Network Interface ID to allow routing to network interface attachments. </summary> <param name="networkInterfaceId">Network interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.WithVpcPeeringConnectionId(System.String)"> <summary> Sets the VpcPeeringConnectionId <param name="vpcPeeringConnectionId">The VpcPeeringConnectionId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteRequest.IsSetVpcPeeringConnectionId"> <summary> Checks if VpcPeeringConnectionId is set </summary> <returns>true if VpcPeeringConnectionId property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.RouteTableId"> <summary> The ID of the route table where the route will be replaced. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.DestinationCidrBlock"> <summary> The CIDR address block used for the destination match. For example: 0.0.0.0/0. The value you provide must match the CIDR of an existing route in the table. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.GatewayId"> <summary> The ID of a gateway attached to your VPC. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.InstanceId"> <summary> The ID of a NAT instance in your VPC. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.NetworkInterfaceId"> <summary> Network Interface ID to allow routing to network interface attachments. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.VpcPeeringConnectionId"> <summary> The ID of a VPC peering connection. </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteResponse"> <summary> The Response for the ReplaceRoute operation. </summary> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest"> <summary> Changes the route table associated with a given subnet in a VPC. </summary> <remarks> After you execute this action, the subnet uses the routes in the new route table it's associated with. For more information about route tables, go to Route Tables in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.WithAssociationId(System.String)"> <summary> Sets the ID representing the current association between the original route table and the subnet. </summary> <param name="associationId">The ID representing the current association between the original route table and the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.IsSetAssociationId"> <summary> Checks if AssociationId property is set </summary> <returns>true if AssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.WithRouteTableId(System.String)"> <summary> Sets the ID of the new route table to associate with the subnet. </summary> <param name="routeTableId">The ID of the new route table to associate with the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.AssociationId"> <summary> The ID representing the current association between the original route table and the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.RouteTableId"> <summary> The ID of the new route table to associate with the subnet. </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse"> <summary> The Response for the ReplaceRouteTableAssociation operation. </summary> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse.IsSetReplaceRouteTableAssociationResult"> <summary> Checks if ReplaceRouteTableAssociationResult property is set </summary> <returns>true if ReplaceRouteTableAssociationResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse.ReplaceRouteTableAssociationResult"> <summary> Gets and sets the ReplaceRouteTableAssociationResult property. ReplaceRouteTableAssociation Result </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteTableAssociationResult"> <summary> ReplaceRouteTableAssociation Result </summary> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationResult.IsSetNewAssociationId"> <summary> Checks if NewAssociationId property is set </summary> <returns>true if NewAssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReplaceRouteTableAssociationResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationResult.NewAssociationId"> <summary> Gets and sets the NewAssociationId property. The ID representing the new association. </summary> </member> <member name="T:Amazon.EC2.Model.ReportInstanceStatusRequest"> <summary> Submits feedback about an instance's status. </summary> <remarks> This action works only for instances that are in the running state. If your experience with the instance differs from the instance status returned by the DescribeInstanceStatus action, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus. </remarks> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.WithInstanceId(System.String[])"> <summary> Sets one or more instance IDs. </summary> <param name="list">Instance IDs to report on.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.IsSetInstanceId"> <summary> Checks if the InstanceId property is set </summary> <returns>true if the InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.WithStatus(System.String)"> <summary> Sets the status of all submitted instances. </summary> <param name="status">Status for the instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.IsSetStatus"> <summary> Checks if the Status property is set </summary> <returns>true if the Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.WithStartTime(System.String)"> <summary> Sets the time at which the reported instance health state began. </summary> <param name="startTime">The start time of the health state</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.IsSetStartTime"> <summary> Checks if the StartTime property is set. </summary> <returns>True if the StartTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.WithEndTime(System.String)"> <summary> Sets the time at which the reported instance health state ended. </summary> <param name="endTime">The end time of the health state</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.IsSetEndTime"> <summary> Checks if the EndTime property is set. </summary> <returns>true if the EndTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.WithReasonCode(System.String[])"> <summary> Sets the reason codes that describe the specified instances health states </summary> <param name="list">One or more reason codes</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.IsSetReasonCode"> <summary> Checks if the ReasonCode property is set </summary> <returns>true if the ReasonCode property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.WithDescription(System.String)"> <summary> Sets the description text about the instance health state. </summary> <param name="description"></param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusRequest.IsSetDescription"> <summary> Checks if the Description property is set </summary> <returns>true if the Description property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.InstanceId"> <summary> One or more instance IDs. </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.Status"> <summary> The status of all submitted instances. </summary> <remarks> Valid Values: ok | impaired </remarks> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.StartTime"> <summary> The time at which the reported instance health state began. </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.EndTime"> <summary> The time at which the reported instance health state ended. </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.ReasonCode"> <summary> Reason codes that describe the specified instances health states. </summary> <remarks> Each code you supply corresponds to an instance ID that you supply in the InstanceID collection. Valid Values: instance-stuck-in-state | unresponsive | not-accepting-credentials | password-not-available | performance-network | performance-instance-store | performance-ebs-volume | performance-other | other </remarks> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.Description"> <summary> Description text about the instance health state. </summary> </member> <member name="T:Amazon.EC2.Model.ReportInstanceStatusResponse"> <summary> Report Instance Status response. </summary> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ReportInstanceStatusResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotInstancesRequest"> <summary> Creates a Spot Instance request. </summary> <remarks> Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum 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. </remarks> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithSpotPrice(System.String)"> <summary> Sets the maximum price you will pay to launch one or more Spot Instances. </summary> <param name="spotPrice">Specifies the maximum price you will pay to launch one or more Spot Instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetSpotPrice"> <summary> Checks if SpotPrice property is set </summary> <returns>true if SpotPrice property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithInstanceCount(System.Decimal)"> <summary> Sets the maximum number of Spot Instances to launch. </summary> <param name="instanceCount">The maximum number of Spot Instances to launch. Default - 1.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetInstanceCount"> <summary> Checks if InstanceCount property is set </summary> <returns>true if InstanceCount property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithType(System.String)"> <summary> Sets the Spot Instance request type. </summary> <param name="type">The instance type. Valid values: one-time | persistent. Default - one-time.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithValidFrom(System.String)"> <summary> Sets the start date of the request. </summary> <param name="validFrom">Start date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled. Default: Request is effective immediately</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetValidFrom"> <summary> Checks if ValidFrom property is set </summary> <returns>true if ValidFrom property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithValidUntil(System.String)"> <summary> Sets the end date of the request. </summary> <param name="validUntil">End date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled. Default: Request remains open until criteria for closing are met</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetValidUntil"> <summary> Checks if ValidUntil property is set </summary> <returns>true if ValidUntil property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithLaunchGroup(System.String)"> <summary> Sets the instance launch group. </summary> <param name="launchGroup">Specifies the instance launch group. Launch groups are Spot Instances that launch together and terminate together. Default: Instances are launched and terminated individually</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetLaunchGroup"> <summary> Checks if LaunchGroup property is set </summary> <returns>true if LaunchGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithAvailabilityZoneGroup(System.String)"> <summary> Sets the Availability Zone group. </summary> <param name="availabilityZoneGroup">Specifies the Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. Default: Instances are launched in any available Availability Zone.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetAvailabilityZoneGroup"> <summary> Checks if AvailabilityZoneGroup property is set </summary> <returns>true if AvailabilityZoneGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.WithLaunchSpecification(Amazon.EC2.Model.LaunchSpecification)"> <summary> Sets additional launch instance information. </summary> <param name="launchSpecification">Specifies additional launch instance information.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.IsSetLaunchSpecification"> <summary> Checks if LaunchSpecification property is set </summary> <returns>true if LaunchSpecification property is set</returns> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.SpotPrice"> <summary> The maximum price you will pay to launch one or more Spot Instances. </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.InstanceCount"> <summary> The maximum number of Spot Instances to launch. Default is 1. </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.Type"> <summary> The Spot Instance request type. Valid values: one-time | persistent Default - one-time. </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.ValidFrom"> <summary> Start date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled. Default: Request is effective immediately </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.ValidUntil"> <summary> End date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled. Default: Request remains open until criteria for closing are met </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.LaunchGroup"> <summary> The instance launch group. Launch groups are Spot Instances that launch together and terminate together. Default: Instances are launched and terminated individually </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.AvailabilityZoneGroup"> <summary> The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. Default: Instances are launched in any available Availability Zone. </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.LaunchSpecification"> <summary> Additional launch instance information. </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotInstancesResponse"> <summary> The Response for the RequestSpotInstances operation. </summary> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesResponse.IsSetRequestSpotInstancesResult"> <summary> Checks if RequestSpotInstancesResult property is set </summary> <returns>true if RequestSpotInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesResponse.RequestSpotInstancesResult"> <summary> Gets and sets the RequestSpotInstancesResult property. Result of the Request Spot Instances operation. </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotInstancesResult"> <summary> Result of the Request Spot Instances operation. </summary> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesResult.IsSetSpotInstanceRequest"> <summary> Checks if SpotInstanceRequest property is set </summary> <returns>true if SpotInstanceRequest property is set</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesResult.SpotInstanceRequest"> <summary> Gets and sets the SpotInstanceRequest property. A list of the SpotInstanceRequest objects returned by the service. </summary> </member> <member name="T:Amazon.EC2.Model.Reservation"> <summary> Reservation information. </summary> </member> <member name="M:Amazon.EC2.Model.Reservation.WithReservationId(System.String)"> <summary> Sets the unique ID of the reservation. </summary> <param name="reservationId">Unique ID of the reservation.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.IsSetReservationId"> <summary> Checks if ReservationId property is set </summary> <returns>true if ReservationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.WithOwnerId(System.String)"> <summary> Sets the AWS Access Key ID of the user who owns the reservation </summary> <param name="ownerId">AWS Access Key ID of the user who owns the reservation</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.IsSetOwnerId"> <summary> Checks if OwnerId property is set </summary> <returns>true if OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.WithRequesterId(System.String)"> <summary> Sets the ID of the requester. </summary> <param name="requesterId">ID of the requester.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.IsSetRequesterId"> <summary> Checks if RequesterId property is set </summary> <returns>true if RequesterId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.WithGroupId(System.String[])"> <summary> Sets the security group IDs for the reservation. </summary> <param name="list">Ids of the security groups.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.WithGroupName(System.String[])"> <summary> Sets the security group names for the reservation. </summary> <param name="list">Names of the security groups.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.WithRunningInstance(Amazon.EC2.Model.RunningInstance[])"> <summary> Sets the running instances </summary> <param name="list">Running instance</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Reservation.IsSetRunningInstance"> <summary> Checks if RunningInstance property is set </summary> <returns>true if RunningInstance property is set</returns> </member> <member name="P:Amazon.EC2.Model.Reservation.ReservationId"> <summary> Unique ID of the reservation. </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.OwnerId"> <summary> AWS Access Key ID of the user who owns the reservation </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.RequesterId"> <summary> ID of the requester. </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.GroupId"> <summary> Security group IDs for the reservation. </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.GroupName"> <summary> Security group names for the reservation. </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.RunningInstance"> <summary> Running instances </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstanceLimitPrice"> <summary> Reserved Instance Limit Price </summary> </member> <member name="M:Amazon.EC2.Model.ReservedInstanceLimitPrice.WithAmount(System.Decimal)"> <summary> Sets the limit price on the total order (instanceCount * price) for Reserved Instance Marketplace offerings. </summary> <param name="amount">Limit price</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstanceLimitPrice.IsSetAmount"> <summary> Checks if the Amount property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstanceLimitPrice.WithCurrencyCode(System.String)"> <summary> Sets the currency in which the limitPrice amount is specified. </summary> <param name="currencyCode">Currency Code</param> <returns>this instance</returns> <remarks> At this time, the only supported currency is USD. </remarks> </member> <member name="M:Amazon.EC2.Model.ReservedInstanceLimitPrice.IsSetCurrencyCode"> <summary> Checks if the CurrencyCode property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReservedInstanceLimitPrice.Amount"> <summary> The limit price on the total order (instanceCount * price) for Reserved Instance Marketplace offerings. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstanceLimitPrice.CurrencyCode"> <summary> The currency in which the limitPrice amount is specified. </summary> <remarks> At this time, the only supported currency is USD. </remarks> </member> <member name="T:Amazon.EC2.Model.ReservedInstances"> <summary> Reserved instances </summary> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithReservedInstancesId(System.String)"> <summary> Sets the ID of the Reserved Instances. </summary> <param name="reservedInstancesId">The ID of the Reserved Instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetReservedInstancesId"> <summary> Checks if ReservedInstancesId property is set </summary> <returns>true if ReservedInstancesId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithInstanceType(System.String)"> <summary> Sets the instance type on which the Reserved Instance can be used. </summary> <param name="instanceType">The instance type on which the Reserved Instance can be used.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone in which the Reserved Instance can be used. </summary> <param name="availabilityZone">The Availability Zone in which the Reserved Instance can be used.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithDuration(System.Decimal)"> <summary> Sets the duration of the Reserved Instance, in seconds. </summary> <param name="duration">The duration of the Reserved Instance, in seconds.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetDuration"> <summary> Checks if Duration property is set </summary> <returns>true if Duration property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithUsagePrice(System.String)"> <summary> Sets the usage price of the Reserved Instance, per hour. </summary> <param name="usagePrice">The usage price of the Reserved Instance, per hour.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetUsagePrice"> <summary> Checks if UsagePrice property is set </summary> <returns>true if UsagePrice property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithFixedPrice(System.String)"> <summary> Sets the purchase price of the Reserved Instance. </summary> <param name="fixedPrice">The purchase price of the Reserved Instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetFixedPrice"> <summary> Checks if FixedPrice property is set </summary> <returns>true if FixedPrice property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithInstanceCount(System.Decimal)"> <summary> Sets the number of Reserved Instances purchased. </summary> <param name="instanceCount">The number of Reserved Instances purchased.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetInstanceCount"> <summary> Checks if InstanceCount property is set </summary> <returns>true if InstanceCount property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithProductDescription(System.String)"> <summary> Sets the Reserved Instance description. </summary> <param name="productDescription">The Reserved Instance description.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetProductDescription"> <summary> Checks if ProductDescription property is set </summary> <returns>true if ProductDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithPurchaseState(System.String)"> <summary> Sets the state of the Reserved Instance purchase. </summary> <param name="purchaseState">The state of the Reserved Instance purchase. Valid Values: pending-payment | active | payment-failed | retired</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetPurchaseState"> <summary> Checks if PurchaseState property is set </summary> <returns>true if PurchaseState property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithStartTime(System.String)"> <summary> Sets the date and time the Reserved Instance started. </summary> <param name="startTime">The date and time the Reserved Instance started.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetStartTime"> <summary> Checks if StartTime property is set </summary> <returns>true if StartTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the list of tags for the ReservedInstances. </summary> <param name="list">A list of tags for the ReservedInstances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetOfferingType"> <summary> Sets the Reserved Instance Offering type. </summary> <returns>true if OfferingType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithOfferingType(System.String)"> <summary> Sets the OfferingType property </summary> <param name="offeringType">The Reserved Instance Offering type</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetRecurringCharges"> <summary> Checks if RecurringCharges property is set </summary> <returns>true if RecurringCharges property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetInstanceTenancy"> <summary> Checks if InstanceTenancy property is set </summary> <returns>true if InstanceTenancy property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithInstanceTenancy(System.String)"> <summary> Sets the tenancy of the reserved instance. </summary> <param name="instanceTenancy">The tenancy of the reserved instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.IsSetCurrencyCode"> <summary> Checks if CurrencyCode property is set </summary> <returns>true if InstanceTenancy property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstances.WithCurrencyCode(System.String)"> <summary> Sets the currency of the Reserved Instance offering you are purchasing. </summary> <param name="currencyCode">The ISO 4217 CurrencyCode (e.g., USD, JPY).</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.ReservedInstancesId"> <summary> The ID of the Reserved Instances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.InstanceType"> <summary> The instance type on which the Reserved Instance can be used. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.AvailabilityZone"> <summary> The Availability Zone in which the Reserved Instance can be used. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.Duration"> <summary> The duration of the Reserved Instance, in seconds. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.UsagePrice"> <summary> The usage price of the Reserved Instance, per hour. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.FixedPrice"> <summary> The purchase price of the Reserved Instance. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.InstanceCount"> <summary> The number of Reserved Instances purchased. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.ProductDescription"> <summary> The Reserved Instance description. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.PurchaseState"> <summary> The state of the Reserved Instance purchase. Valid Values: pending-payment | active | payment-failed | retired </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.StartTime"> <summary> The date and time the Reserved Instance started. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.Tag"> <summary> A list of tags for the ReservedInstances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.OfferingType"> <summary> The Reserved Instance Offering type. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.RecurringCharges"> <summary> Zero or more recurring charges associated with the Reserved Instance. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.InstanceTenancy"> <summary> The tenancy of the reserved instance. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.CurrencyCode"> <summary> The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard (e.g., USD, JPY). </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesOffering"> <summary> Reserved Instances Offering </summary> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithReservedInstancesOfferingId(System.String)"> <summary> Sets the ID of the Reserved Instance offering. </summary> <param name="reservedInstancesOfferingId">The ID of the Reserved Instance offering.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetReservedInstancesOfferingId"> <summary> Checks if ReservedInstancesOfferingId property is set </summary> <returns>true if ReservedInstancesOfferingId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithInstanceType(System.String)"> <summary> Sets the instance type on which the Reserved Instance can be used. </summary> <param name="instanceType">The instance type on which the Reserved Instance can be used.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone in which the Reserved Instance can be used. </summary> <param name="availabilityZone">The Availability Zone in which the Reserved Instance can be used.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithDuration(System.Decimal)"> <summary> Sets the duration of the Reserved Instance, in seconds. </summary> <param name="duration">The duration of the Reserved Instance, in seconds.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetDuration"> <summary> Checks if Duration property is set </summary> <returns>true if Duration property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithUsagePrice(System.String)"> <summary> Sets the usage price of the Reserved Instance, per hour. </summary> <param name="usagePrice">The usage price of the Reserved Instance, per hour.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetUsagePrice"> <summary> Checks if UsagePrice property is set </summary> <returns>true if UsagePrice property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithFixedPrice(System.String)"> <summary> Sets the purchase price of the Reserved Instance. </summary> <param name="fixedPrice">The purchase price of the Reserved Instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetFixedPrice"> <summary> Checks if FixedPrice property is set </summary> <returns>true if FixedPrice property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithProductDescription(System.String)"> <summary> Sets the Reserved Instance description. </summary> <param name="productDescription">The Reserved Instance description.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetProductDescription"> <summary> Checks if ProductDescription property is set </summary> <returns>true if ProductDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetInstanceTenancy"> <summary> Checks if InstanceTenancy property is set </summary> <returns>true if InstanceTenancy property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithInstanceTenancy(System.String)"> <summary> Sets the tenancy of the reserved instance. </summary> <param name="instanceTenancy">The tenancy of the reserved instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetCurrencyCode"> <summary> Checks if CurrencyCode property is set </summary> <returns>true if CurrencyCode property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithCurrencyCode(System.String)"> <summary> Sets the currency of the Reserved Instance offering you are purchasing. </summary> <param name="currencyCode">The ISO 4217 CurrencyCode (e.g., USD, JPY).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetOfferingType"> <summary> Checks if OfferingType property is set </summary> <returns>true if OfferingType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithOfferingType(System.String)"> <summary> Sets the Reserved Instance Offering type. </summary> <param name="offeringType">The Reserved Instance Offering type</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithRecurringCharges(Amazon.EC2.Model.RecurringCharges[])"> <summary> Sets recurring charges associated with the Reserved Instance offering. </summary> <param name="list">Zero or more recurring charges associated with the Reserved Instance offering.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetRecurringCharges"> <summary> Checks if RecurringCharges property is set </summary> <returns>true if RecurringCharges property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithIsMarketplace(System.Boolean)"> <summary> Sets whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. </summary> <param name="isMarketplace">True if it is a Marketplace offering.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetIsMarketplace"> <summary> Checks if the IsMarketplace property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.WithPricingDetails(Amazon.EC2.Model.PricingDetails[])"> <summary> Sets the pricing details of the Reserved Instance offering. </summary> <param name="list">Pricing details for the offering</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ReservedInstancesOffering.IsSetPricingDetails"> <summary> Checks if the PricingDetails property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.ReservedInstancesOfferingId"> <summary> The ID of the Reserved Instance offering. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.InstanceType"> <summary> The instance type on which the Reserved Instance can be used. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.AvailabilityZone"> <summary> The Availability Zone in which the Reserved Instance can be used. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.Duration"> <summary> The duration of the Reserved Instance, in seconds. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.UsagePrice"> <summary> The usage price of the Reserved Instance, per hour. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.FixedPrice"> <summary> The purchase price of the Reserved Instance. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.ProductDescription"> <summary> The Reserved Instance description. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.InstanceTenancy"> <summary> The tenancy of the reserved instance. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.CurrencyCode"> <summary> The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard (e.g., USD, JPY). </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.OfferingType"> <summary> The Reserved Instance Offering type. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.RecurringCharges"> <summary> Zero or more recurring charges associated with the Reserved Instance offering. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.IsMarketPlace"> <summary> Whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. True if it is a Marketplace offering. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.PricingDetails"> <summary> The pricing details of the Reserved Instance offering. </summary> </member> <member name="T:Amazon.EC2.Model.ResetImageAttributeRequest"> <summary> Resets an attribute of an AMI to its default value. Note - The productCodes attribute cannot be reset. </summary> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeRequest.WithImageId(System.String)"> <summary> Sets the ID of the AMI on which the attribute will be reset </summary> <param name="imageId">ID of the AMI on which the attribute will be reset</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeRequest.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeRequest.WithAttribute(System.String)"> <summary> Sets the attribute to reset </summary> <param name="attribute">Specifies the attribute to reset</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.ResetImageAttributeRequest.ImageId"> <summary> ID of the AMI on which the attribute will be reset </summary> </member> <member name="P:Amazon.EC2.Model.ResetImageAttributeRequest.Attribute"> <summary> The attribute to reset </summary> </member> <member name="T:Amazon.EC2.Model.ResetImageAttributeResponse"> <summary> Reset Image Attribute Response </summary> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ResetImageAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ResetInstanceAttributeRequest"> <summary> Resets an attribute of an instance to its default value. </summary> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeRequest.WithInstanceId(System.String)"> <summary> Sets the ID of the instance on which the attribute will be reset. </summary> <param name="instanceId">ID of the instance on which the attribute will be reset.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeRequest.WithAttribute(System.String)"> <summary> Sets the name of the attribute to reset. </summary> <param name="attribute">Name of the attribute to reset. Values are "sourceDestCheck", "kernel" and "ramdisk".</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.ResetInstanceAttributeRequest.InstanceId"> <summary> ID of the instance on which the attribute will be reset. </summary> </member> <member name="P:Amazon.EC2.Model.ResetInstanceAttributeRequest.Attribute"> <summary> Name of the attribute to reset. Valid Values are "sourceDestCheck", "kernel" and "ramdisk". </summary> </member> <member name="T:Amazon.EC2.Model.ResetInstanceAttributeResponse"> <summary> Information returned by a ResetInstanceAttribute request. </summary> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ResetInstanceAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest"> <summary> Reset Network Interface Attribute request </summary> </member> <member name="M:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the ID of the network interface on which the attribute will be reset. </summary> <param name="networkInterfaceId">Network Interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.IsSetNetworkInterfaceId"> <summary> Checks if NetworkInterfaceId property is set </summary> <returns>true if NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.WithAttribute(System.String)"> <summary> Sets the name of the attribute to reset. </summary> <param name="attribute">Name of the attribute to reset. If not set, defaults to sourceDestCheck. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.IsSetAttribute"> <summary> Checks if the Attribute property is set </summary> <returns>true if the Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.NetworkInterfaceId"> <summary> ID of the network interface on which the attribute will be reset. </summary> </member> <member name="P:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.Attribute"> <summary> Name of the attribute to reset. </summary> </member> <member name="T:Amazon.EC2.Model.ResetNetworkInterfaceAttributeResponse"> <summary> Reset Network Interface Attribute response </summary> </member> <member name="M:Amazon.EC2.Model.ResetNetworkInterfaceAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetNetworkInterfaceAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ResetNetworkInterfaceAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ResetNetworkInterfaceAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ResetSnapshotAttributeRequest"> <summary> Resets permission settings for the specified snapshot </summary> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeRequest.WithSnapshotId(System.String)"> <summary> Sets the ID of the snapshot. </summary> <param name="snapshotId">The ID of the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeRequest.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeRequest.WithAttribute(System.String)"> <summary> Sets the attribute to reset. </summary> <param name="attribute">Resets the create volume permissions of the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeRequest.IsSetAttribute"> <summary> Checks if Attribute property is set </summary> <returns>true if Attribute property is set</returns> </member> <member name="P:Amazon.EC2.Model.ResetSnapshotAttributeRequest.SnapshotId"> <summary> The ID of the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.ResetSnapshotAttributeRequest.Attribute"> <summary> The attribute to reset. Currently only the attribute for permission to create volumes can be reset. </summary> </member> <member name="T:Amazon.EC2.Model.ResetSnapshotAttributeResponse"> <summary> Reset Snapshot Attribute Response </summary> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.ResetSnapshotAttributeResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.ResourceTag"> <summary> Resource tag </summary> </member> <member name="M:Amazon.EC2.Model.ResourceTag.WithResourceId(System.String)"> <summary> Sets the resource ID for the Tag. </summary> <param name="resourceId">The resource ID for the Tag.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResourceTag.IsSetResourceId"> <summary> Checks if ResourceId property is set </summary> <returns>true if ResourceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResourceTag.WithResourceType(System.String)"> <summary> Sets the type of resource identified by the associated resource ID </summary> <param name="resourceType">The type of resource identified by the associated resource ID (ex: instance, AMI, EBS volume, etc).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResourceTag.IsSetResourceType"> <summary> Checks if ResourceType property is set </summary> <returns>true if ResourceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResourceTag.WithKey(System.String)"> <summary> Sets the tag's key. </summary> <param name="key">The tag's key.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResourceTag.IsSetKey"> <summary> Checks if Key property is set </summary> <returns>true if Key property is set</returns> </member> <member name="M:Amazon.EC2.Model.ResourceTag.WithValue(System.String)"> <summary> Sets the tag's value. </summary> <param name="value">The tag's value.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResourceTag.IsSetValue"> <summary> Checks if Value property is set </summary> <returns>true if Value property is set</returns> </member> <member name="P:Amazon.EC2.Model.ResourceTag.ResourceId"> <summary> The resource ID for the Tag. </summary> </member> <member name="P:Amazon.EC2.Model.ResourceTag.ResourceType"> <summary> The type of resource identified by the associated resource ID (ex: instance, AMI, EBS volume, etc). </summary> </member> <member name="P:Amazon.EC2.Model.ResourceTag.Key"> <summary> The tag's key. </summary> </member> <member name="P:Amazon.EC2.Model.ResourceTag.Value"> <summary> The tag's value. </summary> </member> <member name="T:Amazon.EC2.Model.ResponseMetadata"> <summary> Response Metadata </summary> </member> <member name="M:Amazon.EC2.Model.ResponseMetadata.WithRequestId(System.String)"> <summary> Sets the request Id </summary> <param name="requestId">Request Id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.ResponseMetadata.IsSetRequestId"> <summary> Checks if RequestId property is set </summary> <returns>true if RequestId property is set</returns> </member> <member name="P:Amazon.EC2.Model.ResponseMetadata.RequestId"> <summary> Request Id </summary> </member> <member name="T:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest"> <summary> Removes one or more egress rules from a VPC security group. </summary> <remarks> This action applies only to security groups in a VPC. It doesn't work with standard (EC2) security groups. For information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual Private Cloud User Guide. The values that you specify in the revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to be revoked. Each rule consists of the protocol, and the CIDR range or destination 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. Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </remarks> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.WithGroupId(System.String)"> <summary> Sets the ID of the VPC security group to modify. </summary> <param name="groupId">ID of the VPC security group to modify.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.WithIpPermissions(Amazon.EC2.Model.IpPermissionSpecification[])"> <summary> Sets the IP permissions associated with the security group. </summary> <param name="list">Set of IP permissions associated with the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.IsSetIpPermissions"> <summary> Checks if IpPermissions property is set </summary> <returns>true if IpPermissions property is set</returns> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.GroupId"> <summary> ID of the VPC security group to modify. </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.IpPermissions"> <summary> Set of IP permissions associated with the security group. </summary> </member> <member name="T:Amazon.EC2.Model.RevokeSecurityGroupEgressResponse"> <summary> The Response for the RevokeSecurityGroupEgress operation. </summary> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupEgressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupEgressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupEgressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupEgressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest"> <summary> Revokes permissions from a security group. </summary> <remarks> The permissions used to revoke must be specified using the same values used to grant the permissions. Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP). Permission changes are quickly propagated to instances within the security group. However, depending on the number of instances in the group, a small delay is might occur. </remarks> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithUserId(System.String)"> <summary> Sets the AWS Access Key ID. </summary> <param name="userId">AWS Access Key ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetUserId"> <summary> Checks if UserId property is set </summary> <returns>true if UserId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithGroupId(System.String)"> <summary> Sets the id of the standard (EC2) or VPC security group to modify. </summary> <param name="groupId">Id of the standard (EC2) or VPC security group to modify. Conditional The group must belong to your account.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithGroupName(System.String)"> <summary> Sets the name of the group to modify. </summary> <param name="groupName">Name of the group to modify.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithSourceSecurityGroupName(System.String)"> <summary> Sets the name of the security group. </summary> <param name="sourceSecurityGroupName">Name of the security group. Cannot be used when specifying a CIDR IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetSourceSecurityGroupName"> <summary> Checks if SourceSecurityGroupName property is set </summary> <returns>true if SourceSecurityGroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithSourceSecurityGroupOwnerId(System.String)"> <summary> Sets the AWS User ID of an account. </summary> <param name="sourceSecurityGroupOwnerId">AWS User ID of an account. Cannot be used when specifying a CIDR IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetSourceSecurityGroupOwnerId"> <summary> Checks if SourceSecurityGroupOwnerId property is set </summary> <returns>true if SourceSecurityGroupOwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithIpProtocol(System.String)"> <summary> Sets the IP protocol. </summary> <param name="ipProtocol">IP protocol. Valid Values: tcp | udp | icmp</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetIpProtocol"> <summary> Checks if IpProtocol property is set </summary> <returns>true if IpProtocol property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithFromPort(System.Decimal)"> <summary> Sets the start of port range for the TCP and UDP protocols, or an ICMP type number. </summary> <param name="fromPort">Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetFromPort"> <summary> Checks if FromPort property is set </summary> <returns>true if FromPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithToPort(System.Decimal)"> <summary> Sets the end of port range for the TCP and UDP protocols, or an ICMP code. </summary> <param name="toPort">End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetToPort"> <summary> Checks if ToPort property is set </summary> <returns>true if ToPort property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithCidrIp(System.String)"> <summary> Sets the CIDR range. </summary> <param name="cidrIp">CIDR range.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetCidrIp"> <summary> Checks if CidrIp property is set </summary> <returns>true if CidrIp property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.WithIpPermissions(Amazon.EC2.Model.IpPermissionSpecification[])"> <summary> Sets the IP permissions associated with the security group. </summary> <param name="list">Set of IP permissions associated with the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IsSetIpPermissions"> <summary> Checks if IpPermissions property is set </summary> <returns>true if IpPermissions property is set</returns> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.UserId"> <summary> AWS Access Key ID. </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.GroupId"> <summary> Id of the standard (EC2) or VPC security group to modify. The group must belong to your account. </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.GroupName"> <summary> Name of the group to modify. </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.SourceSecurityGroupName"> <summary> Name of the security group. Cannot be used when specifying a CIDR IP address. </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.SourceSecurityGroupOwnerId"> <summary> AWS User ID of an account. Cannot be used when specifying a CIDR IP address. </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IpProtocol"> <summary> IP protocol. Valid Values: tcp | udp | icmp </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.FromPort"> <summary> Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number). </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.ToPort"> <summary> End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code). </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.CidrIp"> <summary> CIDR range. </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IpPermissions"> <summary> Set of IP permissions associated with the security group. </summary> </member> <member name="T:Amazon.EC2.Model.RevokeSecurityGroupIngressResponse"> <summary> Revoke Security GroupIngress Response </summary> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.Route"> <summary> Route description </summary> </member> <member name="M:Amazon.EC2.Model.Route.WithDestinationCidrBlock(System.String)"> <summary> Sets the CIDR address block used for the destination match. </summary> <param name="destinationCidrBlock">The CIDR address block used for the destination match. For example: 0.0.0.0/0.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetDestinationCidrBlock"> <summary> Checks if DestinationCidrBlock property is set </summary> <returns>true if DestinationCidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.Route.WithGatewayId(System.String)"> <summary> Sets the ID of a gateway attached to your VPC. </summary> <param name="gatewayId">The ID of a gateway attached to your VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetGatewayId"> <summary> Checks if GatewayId property is set </summary> <returns>true if GatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Route.WithInstanceId(System.String)"> <summary> Sets the ID of a NAT instance in your VPC. </summary> <param name="instanceId">The ID of a NAT instance in your VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Route.WithState(System.String)"> <summary> Sets the state of the route. </summary> <param name="state">The state of the route.The blackhole state indicates that the route's target isn't available (e.g., the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, etc.).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="M:Amazon.EC2.Model.Route.WithInstanceOwnerId(System.String)"> <summary> Sets the owner of the instance. </summary> <param name="instanceOwnerId">The owner of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetInstanceOwnerId"> <summary> Checks if the InstanceOwnerId property is set </summary> <returns>true if the InstanceOwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Route.WithNetworkInterfaceId(System.String)"> <summary> Sets the network interface ID. </summary> <param name="networkInterfaceId">Network interface ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Route.WithVpcPeeringConnectionId(System.String)"> <summary> Sets the VpcPeeringConnectionId <param name="vpcPeeringConnectionId">The VpcPeeringConnectionId.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetVpcPeeringConnectionId"> <summary> Checks if VpcPeeringConnectionId is set </summary> <returns>true if VpcPeeringConnectionId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Route.WithOrigin(System.String)"> <summary> Sets the Origin <param name="origin">The Origin.</param> </summary> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Route.IsSetOrigin"> <summary> Checks if Origin is set </summary> <returns>true if Origin property is set</returns> </member> <member name="P:Amazon.EC2.Model.Route.DestinationCidrBlock"> <summary> The CIDR address block used for the destination match. For example: 0.0.0.0/0. </summary> </member> <member name="P:Amazon.EC2.Model.Route.GatewayId"> <summary> The ID of a gateway attached to your VPC. </summary> </member> <member name="P:Amazon.EC2.Model.Route.InstanceId"> <summary> The ID of a NAT instance in your VPC. </summary> </member> <member name="P:Amazon.EC2.Model.Route.State"> <summary> The state of the route. The blackhole state indicates that the route's target isn't available (e.g., the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, etc.). </summary> </member> <member name="P:Amazon.EC2.Model.Route.InstanceOwnerId"> <summary> The owner of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.Route.NetworkInterfaceId"> <summary> The network interface ID. </summary> </member> <member name="P:Amazon.EC2.Model.Route.VpcPeeringConnectionId"> <summary> The ID of the VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.Route.Origin"> <summary> Describes how the route was created. <ul> <li><c>CreateRouteTable</c> indicates that route was automatically created when the route table was created.</li> <li><c>CreateRoute</c> indicates that the route was manually added to the route table.</li> <li><c>EnableVgwRoutePropagation</c> indicates that the route was propagated by route propagation.</li> </ul> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>CreateRouteTable, CreateRoute, EnableVgwRoutePropagation</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.EC2.Model.RouteTable"> <summary> Route Table </summary> </member> <member name="M:Amazon.EC2.Model.RouteTable.WithRouteTableId(System.String)"> <summary> Sets the route table's ID. </summary> <param name="routeTableId">The route table's ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.WithVpcId(System.String)"> <summary> Sets the ID of the VPC the route table is in. </summary> <param name="vpcId">The ID of the VPC the route table is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.WithRoutes(Amazon.EC2.Model.Route[])"> <summary> Sets the list of routes in the route table. </summary> <param name="list">A list of routes in the route table.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.IsSetRoutes"> <summary> Checks if Routes property is set </summary> <returns>true if Routes property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.WithAssociations(Amazon.EC2.Model.RouteTableAssociation[])"> <summary> Sets the associations between the route table and one or more subnets. </summary> <param name="list">A list of associations between the route table and one or more subnets.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.IsSetAssociations"> <summary> Checks if Associations property is set </summary> <returns>true if Associations property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags for the RouteTable. </summary> <param name="list">A list of tags for the RouteTable.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.WithPropagatingVpnGateways(System.String[])"> <summary> DOCS_TODO </summary> <param name="list"></param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.IsSetPropagatingVpnGateways"> <summary> Checks if the PropagatingVpnGateways property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.WithPropagatedRoutes(Amazon.EC2.Model.PropagatedRoute[])"> <summary> DOCS_TODO </summary> <param name="list"></param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTable.IsSetPropagatedRoutes"> <summary> Checks if the PropagatedRoutes property is set </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.RouteTable.RouteTableId"> <summary> The route table's ID. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.VpcId"> <summary> The ID of the VPC the route table is in. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.Routes"> <summary> A list of routes in the route table. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.Associations"> <summary> A list of associations between the route table and one or more subnets. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.Tag"> <summary> A list of tags for the RouteTable. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.PropagatingVpnGateways"> <summary> DOCS_TODO </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.PropagatedRoutes"> <summary> DOCS_TODO </summary> </member> <member name="T:Amazon.EC2.Model.RouteTableAssociation"> <summary> Route Table Association </summary> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.WithRouteTableAssociationId(System.String)"> <summary> Sets an identifier representing the association between a route table and a subnet. </summary> <param name="routeTableAssociationId">An identifier representing the association between a route table and a subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.IsSetRouteTableAssociationId"> <summary> Checks if RouteTableAssociationId property is set </summary> <returns>true if RouteTableAssociationId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.WithRouteTableId(System.String)"> <summary> Sets the ID of the route table in the association. </summary> <param name="routeTableId">The ID of the route table in the association.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.IsSetRouteTableId"> <summary> Checks if RouteTableId property is set </summary> <returns>true if RouteTableId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.WithSubnetId(System.String)"> <summary> Sets the ID of the subnet in the association. </summary> <param name="subnetId">The ID of the subnet in the association.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.WithMain(System.Boolean)"> <summary> Sets whether this is the main route table. </summary> <param name="main">Whether this is the main route table.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RouteTableAssociation.IsSetMain"> <summary> Checks if Main property is set </summary> <returns>true if Main property is set</returns> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.RouteTableAssociationId"> <summary> An identifier representing the association between a route table and a subnet. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.RouteTableId"> <summary> The ID of the route table in the association. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.SubnetId"> <summary> The ID of the subnet in the association. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.Main"> <summary> Whether this is the main route table. </summary> </member> <member name="T:Amazon.EC2.Model.RunInstancesRequest"> <summary> Container for the parameters to the RunInstances operation. <para>Launches the specified number of instances using an AMI for which you have permissions.</para> <para>When you launch an instance, it enters the <c>pending</c> state. After the instance is ready for you, it enters the <c>running</c> state. To check the state of your instance, call DescribeInstances.</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>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, <c>RunInstances</c> 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> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithImageId(System.String)"> <summary> Sets the unique ID of a machine image. </summary> <param name="imageId">Unique ID of a machine image,</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithMinCount(System.Decimal)"> <summary> Sets the minimum number of instances to launch. </summary> <param name="minCount">Minimum number of instances to launch. If the value is more than Amazon EC2 can launch, no instances are launched at all. Constraints: Between 1 and the maximum number allowed for your account (default: 20).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetMinCount"> <summary> Checks if MinCount property is set </summary> <returns>true if MinCount property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithMaxCount(System.Decimal)"> <summary> Sets the maximum number of instances to launch. </summary> <param name="maxCount">Maximum number of instances to launch. If the value is more than Amazon EC2 can launch, the largest possible number above minCount will be launched instead. Constraints: Between 1 and the maximum number allowed for your account (default: 20).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetMaxCount"> <summary> Checks if MaxCount property is set </summary> <returns>true if MaxCount property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithKeyName(System.String)"> <summary> Sets the name of the key pair to use. </summary> <param name="keyName">The name of the key pair.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithSecurityGroup(System.String[])"> <summary> Sets the names of the security groups. </summary> <param name="list">Names of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetSecurityGroup"> <summary> Checks if SecurityGroup property is set </summary> <returns>true if SecurityGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithSecurityGroupId(System.String[])"> <summary> Sets the IDs of the security groups. </summary> <param name="list">IDs of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetSecurityGroupId"> <summary> Checks if SecurityGroupId property is set </summary> <returns>true if SecurityGroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithUserData(System.String)"> <summary> Sets the MIME, Base64-encoded user data. </summary> <param name="userData">MIME, Base64-encoded user data.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetUserData"> <summary> Checks if UserData property is set </summary> <returns>true if UserData property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithInstanceType(System.String)"> <summary> Sets the instance type. </summary> <param name="instanceType">Specifies the instance type. Valid Values: m1.small | m1.medium | m1.large | m1.xlarge | c1.medium | c1.xlarge | m2.2xlarge | m2.4xlarge Default: m1.small</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithPlacement(Amazon.EC2.Model.Placement)"> <summary> Sets the placement constraints. </summary> <param name="placement">Specifies the placement constraints.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetPlacement"> <summary> Checks if Placement property is set </summary> <returns>true if Placement property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithKernelId(System.String)"> <summary> Sets the ID of the kernel with which to launch the instance. </summary> <param name="kernelId">The ID of the kernel with which to launch the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetKernelId"> <summary> Checks if KernelId property is set </summary> <returns>true if KernelId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithRamdiskId(System.String)"> <summary> Sets the ID of the RAM disk with which to launch the instance. </summary> <param name="ramdiskId">The ID of the RAM disk with which to launch the instance. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk. To find kernel requirements, go to the Resource Center and search for the kernel ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetRamdiskId"> <summary> Checks if RamdiskId property is set </summary> <returns>true if RamdiskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithBlockDeviceMapping(Amazon.EC2.Model.BlockDeviceMapping[])"> <summary> Sets the block device mapping. </summary> <param name="list">Block device mapping.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithMonitoring(Amazon.EC2.Model.MonitoringSpecification)"> <summary> Sets the monitoring for the instance. </summary> <param name="monitoring">Enables monitoring for the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetMonitoring"> <summary> Checks if Monitoring property is set </summary> <returns>true if Monitoring property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithSubnetId(System.String)"> <summary> Sets the subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud. </summary> <param name="subnetId">Specifies the subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithDisableApiTermination(System.Boolean)"> <summary> Sets whether the instance can be terminated using the APIs. </summary> <param name="disableApiTermination">Specifies whether the instance can be terminated using the APIs. You must modify this attribute before you can terminate any "locked" instances from the APIs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetDisableApiTermination"> <summary> Checks if DisableApiTermination property is set </summary> <returns>true if DisableApiTermination property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithInstanceInitiatedShutdownBehavior(System.String)"> <summary> Sets whether the instance's Amazon EBS volumes are stopped or terminated when the instance is shut down. </summary> <param name="instanceInitiatedShutdownBehavior">Specifies whether the instance's Amazon EBS volumes are stopped or terminated when the instance is shut down.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetInstanceInitiatedShutdownBehavior"> <summary> Checks if InstanceInitiatedShutdownBehavior property is set </summary> <returns>true if InstanceInitiatedShutdownBehavior property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithLicense(Amazon.EC2.Model.InstanceLicenseSpecification)"> <summary> Sets the active licenses in use and attached to an Amazon EC2 instance. </summary> <param name="license">Specifies active licenses in use and attached to an Amazon EC2 instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetLicense"> <summary> Checks if License property is set </summary> <returns>true if License property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithPrivateIpAddress(System.String)"> <summary> Sets the private IP address for this instance. </summary> <param name="privateIpAddress">If you're using Amazon Virtual Private Cloud, you can optionally use this parameter to assign the instance a specific available IP address from the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetPrivateIpAddress"> <summary> Checks if PrivateIpAddress property is set </summary> <returns>true if PrivateIpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithClientToken(System.String)"> <summary> Sets the unique, case-sensitive identifier to ensure idempotency of the request. </summary> <param name="clientToken">ClientToken property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetClientToken"> <summary> Checks if ClientToken property is set </summary> <returns>true if ClientToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithNetworkInterfaceSet(Amazon.EC2.Model.InstanceNetworkInterfaceSpecification[])"> <summary> Sets one or more existing network interfaces to attach to the instance. </summary> <param name="list">A set of one or more existing network interfaces to attach to the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetNetworkInterfaceSet"> <summary> Checks if the NetworkInterfaceSet property is set </summary> <returns>true if the NetworkInterfaceSet property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithEbsOptimized(System.Boolean)"> <summary> Sets whether to use the EBS IOPS optimized option. </summary> <param name="ebsOptimized">Specifies whether to use the EBS IOPS optimized option.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetEbsOptimized"> <summary> Checks if EbsOptimized property is set </summary> <returns>true if EbsOptimized property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.WithInstanceProfile(Amazon.EC2.Model.IAMInstanceProfile)"> <summary> Sets an Identity and Access Management Instance Profile to associate with the instance. </summary> <param name="instanceProfile"> An Identity and Access Management Instance Profile to associate with the instance. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.IsSetInstanceProfile"> <summary> Checks if the InstanceProfile property is set </summary> <returns>true if the InstanceProfile property is set</returns> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.ImageId"> <summary> Unique ID of a machine image. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.MinCount"> <summary> Minimum number of instances to launch. If the value is more than Amazon EC2 can launch, no instances are launched at all. Constraints: Between 1 and the maximum number allowed for your account (default: 20). </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.MaxCount"> <summary> Maximum number of instances to launch. If the value is more than Amazon EC2 can launch, the largest possible number above minCount will be launched instead. Constraints: Between 1 and the maximum number allowed for your account (default: 20). </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.KeyName"> <summary> The name of the key pair to use. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.SecurityGroup"> <summary> Names of the security groups. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.SecurityGroupId"> <summary> IDs of the security groups. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.UserData"> <summary> MIME, Base64-encoded user data. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.InstanceType"> <summary> The instance type. Valid Values: m1.small | m1.medium | m1.large | m1.xlarge | c1.medium | c1.xlarge | m2.2xlarge | m2.4xlarge Default: m1.small </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.Placement"> <summary> The placement constraints. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.KernelId"> <summary> The ID of the kernel with which to launch the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.RamdiskId"> <summary> The ID of the RAM disk with which to launch the instance. Some kernels require additional drivers at launch. Check the kernel requirements for information on whether you need to specify a RAM disk. To find kernel requirements, go to the Resource Center and search for the kernel ID. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.BlockDeviceMapping"> <summary> Block device mapping. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.Monitoring"> <summary> Monitoring for the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.SubnetId"> <summary> The subnet ID within which to launch the instance(s) for Amazon Virtual Private Cloud. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.DisableApiTermination"> <summary> Whether the instance can be terminated using the APIs. You must modify this attribute before you can terminate any "locked" instances from the APIs. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.InstanceInitiatedShutdownBehavior"> <summary> Whether the instance's Amazon EBS volumes are stopped or terminated when the instance is shut down. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.License"> <summary> Active licenses in use and attached to an Amazon EC2 instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.PrivateIpAddress"> <summary> Private IP address for this instance. <remarks> If you're using Amazon Virtual Private Cloud, you can optionally use this parameter to assign the instance a specific available IP address from the subnet. </remarks> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.ClientToken"> <summary> Unique, case-sensitive identifier you provide to ensure idempotency of the request. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.NetworkInterfaceSet"> <summary> A set of one or more existing network interfaces to attach to the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.EbsOptimized"> <summary> Whether to use the EBS IOPS optimized option. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.InstanceProfile"> <summary> An Identity and Access Management Instance Profile to associate with the instance. </summary> </member> <member name="T:Amazon.EC2.Model.RunInstancesResponse"> <summary> Run Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.RunInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesResponse.IsSetRunInstancesResult"> <summary> Checks if RunInstancesResult property is set </summary> <returns>true if RunInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RunInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesResponse.RunInstancesResult"> <summary> Gets and sets the RunInstancesResult property. Run Instances Result </summary> </member> <member name="T:Amazon.EC2.Model.RunInstancesResult"> <summary> Run Instances Result </summary> </member> <member name="M:Amazon.EC2.Model.RunInstancesResult.IsSetReservation"> <summary> Checks if Reservation property is set </summary> <returns>true if Reservation property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.RunInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.RunInstancesResult.Reservation"> <summary> Gets and sets the Reservation property. Reservation </summary> </member> <member name="T:Amazon.EC2.Model.RunningInstance"> <summary> Launched EC2 Instance </summary> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithInstanceId(System.String)"> <summary> Sets the unique ID of the instance. </summary> <param name="instanceId">Unique ID of the instance launched.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithImageId(System.String)"> <summary> Sets the image ID of the AMI used to launch the instance. </summary> <param name="imageId">Image ID of the AMI used to launch the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetImageId"> <summary> Checks if ImageId property is set </summary> <returns>true if ImageId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithInstanceState(Amazon.EC2.Model.InstanceState)"> <summary> Sets the current state of the instance. </summary> <param name="instanceState">The current state of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetInstanceState"> <summary> Checks if InstanceState property is set </summary> <returns>true if InstanceState property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithPrivateDnsName(System.String)"> <summary> Sets the private DNS name assigned to the instance. </summary> <param name="privateDnsName">The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This element remains empty until the instance enters a running state</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetPrivateDnsName"> <summary> Checks if PrivateDnsName property is set </summary> <returns>true if PrivateDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithPublicDnsName(System.String)"> <summary> Sets the public DNS name assigned to the instance. </summary> <param name="publicDnsName">The public DNS name assigned to the instance. This DNS name is contactable from outside the Amazon EC2 network. This element remains empty until the instance enters a running state</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetPublicDnsName"> <summary> Checks if PublicDnsName property is set </summary> <returns>true if PublicDnsName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithStateTransitionReason(System.String)"> <summary> Sets the reason for the most recent state transition. </summary> <param name="stateTransitionReason">Reason for the most recent state transition. This might be an empty string.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetStateTransitionReason"> <summary> Checks if StateTransitionReason property is set </summary> <returns>true if StateTransitionReason property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithKeyName(System.String)"> <summary> Sets the name of a key pair associated with this instance. </summary> <param name="keyName">If this instance was launched with an associated key pair, this displays the key pair name.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetKeyName"> <summary> Checks if KeyName property is set </summary> <returns>true if KeyName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithAmiLaunchIndex(System.String)"> <summary> Sets the AMI launch index, which can be used to find this instance within the launch group. </summary> <param name="amiLaunchIndex">The AMI launch index, which can be used to find this instance within the launch group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetAmiLaunchIndex"> <summary> Checks if AmiLaunchIndex property is set </summary> <returns>true if AmiLaunchIndex property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithProductCode(System.String[])"> <summary> Sets the product codes attached to this instance. </summary> <param name="list">Product codes attached to this instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetProductCode"> <summary> Checks if ProductCode property is set </summary> <returns>true if ProductCode property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithProductCodes(Amazon.EC2.Model.ProductCode[])"> <summary> Sets the product codes attached to this instance. </summary> <param name="list">Product codes attached to this instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetProductCodes"> <summary> Checks if ProductCodes property is set </summary> <returns>true if ProductCodes property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithInstanceType(System.String)"> <summary> Sets the instance type. </summary> <param name="instanceType">The instance type.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithLaunchTime(System.String)"> <summary> Sets the time the instance launched. </summary> <param name="launchTime">The time the instance launched.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetLaunchTime"> <summary> Checks if LaunchTime property is set </summary> <returns>true if LaunchTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithPlacement(Amazon.EC2.Model.Placement)"> <summary> Sets the location where the instance launched. </summary> <param name="placement">The location where the instance launched.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetPlacement"> <summary> Checks if Placement property is set </summary> <returns>true if Placement property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithKernelId(System.String)"> <summary> Sets the kernel associated with this instance. </summary> <param name="kernelId">Kernel associated with this instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetKernelId"> <summary> Checks if KernelId property is set </summary> <returns>true if KernelId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithRamdiskId(System.String)"> <summary> Sets the RAM disk associated with this instance. </summary> <param name="ramdiskId">RAM disk associated with this instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetRamdiskId"> <summary> Checks if RamdiskId property is set </summary> <returns>true if RamdiskId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithPlatform(System.String)"> <summary> Sets the platform of the instance (e.g., Windows). </summary> <param name="platform">Platform of the instance (e.g., Windows).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetPlatform"> <summary> Checks if Platform property is set </summary> <returns>true if Platform property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithMonitoring(Amazon.EC2.Model.Monitoring)"> <summary> Sets the monitoring configuration for the instance. </summary> <param name="monitoring">Specifies whether monitoring is enabled for the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetMonitoring"> <summary> Checks if Monitoring property is set </summary> <returns>true if Monitoring property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithSubnetId(System.String)"> <summary> Sets the subnet ID in which the instance is running (Amazon Virtual Private Cloud). </summary> <param name="subnetId">Specifies the subnet ID in which the instance is running (Amazon Virtual Private Cloud).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithVpcId(System.String)"> <summary> Sets the VPC in which the instance is running (Amazon Virtual Private Cloud). </summary> <param name="vpcId">Specifies the VPC in which the instance is running (Amazon Virtual Private Cloud).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithPrivateIpAddress(System.String)"> <summary> Sets the private IP address that is assigned to the instance (Amazon VPC). </summary> <param name="privateIpAddress">Specifies the private IP address that is assigned to the instance (Amazon VPC).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetPrivateIpAddress"> <summary> Checks if PrivateIpAddress property is set </summary> <returns>true if PrivateIpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithIpAddress(System.String)"> <summary> Sets the IP address of the instance. </summary> <param name="ipAddress">Specifies the IP address of the instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetIpAddress"> <summary> Checks if IpAddress property is set </summary> <returns>true if IpAddress property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithSourceDestCheck(System.Boolean)"> <summary> Sets whether source/destination checking is enabled on the instance. </summary> <param name="sourceDestCheck"> A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, go to NAT Instances in the Amazon Virtual Private Cloud User Guide. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetSourceDestCheck"> <summary> Checks if SourceDestCheck property is set </summary> <returns>true if SourceDestCheck property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithGroupId(System.String[])"> <summary> Sets the VPC security group names the instance is in. </summary> <param name="list">A list of VPC security groups the instance is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithGroupName(System.String[])"> <summary> Sets the VPC security group IDs the instance is in. </summary> <param name="list">A list of security groups the instance is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithStateReason(Amazon.EC2.Model.StateReason)"> <summary> Sets the reason for the state change. </summary> <param name="stateReason">The reason for the state change.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetStateReason"> <summary> Checks if StateReason property is set </summary> <returns>true if StateReason property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithArchitecture(System.String)"> <summary> Sets the architecture of the image. </summary> <param name="architecture">The architecture of the image.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetArchitecture"> <summary> Checks if Architecture property is set </summary> <returns>true if Architecture property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithRootDeviceType(System.String)"> <summary> Sets the root device type used by the AMI. </summary> <param name="rootDeviceType">The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetRootDeviceType"> <summary> Checks if RootDeviceType property is set </summary> <returns>true if RootDeviceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithRootDeviceName(System.String)"> <summary> Sets the root device name (e.g., /dev/sda1). </summary> <param name="rootDeviceName">The root device name (e.g., /dev/sda1).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetRootDeviceName"> <summary> Checks if RootDeviceName property is set </summary> <returns>true if RootDeviceName property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithBlockDeviceMapping(Amazon.EC2.Model.InstanceBlockDeviceMapping[])"> <summary> Sets the block device mapping configuration. </summary> <param name="list">Block device mapping set.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetBlockDeviceMapping"> <summary> Checks if BlockDeviceMapping property is set </summary> <returns>true if BlockDeviceMapping property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithInstanceLifecycle(System.String)"> <summary> Sets whether this is a Spot Instance. Valid values: spot | blank (no value) </summary> <param name="instanceLifecycle">InstanceLifecycle property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetInstanceLifecycle"> <summary> Checks if InstanceLifecycle property is set </summary> <returns>true if InstanceLifecycle property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithSpotInstanceRequestId(System.String)"> <summary> Sets the ID of the Spot Instance request that started this instance. </summary> <param name="spotInstanceRequestId">The ID of the Spot Instance request that started this instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetSpotInstanceRequestId"> <summary> Checks if SpotInstanceRequestId property is set </summary> <returns>true if SpotInstanceRequestId property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithLicense(Amazon.EC2.Model.InstanceLicense)"> <summary> Sets the active license that is in use and attached to the Amazon EC2 instance. </summary> <param name="license">The active license in use and attached to the Amazon EC2 instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetLicense"> <summary> Checks if License property is set </summary> <returns>true if License property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithVirtualizationType(System.String)"> <summary> Sets whether the Amazon EC2 instance is a hardware virtual machine (HVM) or a para-virtual machine (PVM). </summary> <param name="virtualizationType">Specifies whether the Amazon EC2 instance is a hardware virtual machine (HVM) or a para-virtual machine (PVM).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetVirtualizationType"> <summary> Checks if VirtualizationType property is set </summary> <returns>true if VirtualizationType property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithClientToken(System.String)"> <summary> Sets the idempotency token provided when you launched the instance. </summary> <param name="clientToken">ClientToken property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetClientToken"> <summary> Checks if ClientToken property is set </summary> <returns>true if ClientToken property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags for the RunningInstance. </summary> <param name="list">A list of tags for the RunningInstance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithHypervisor(System.String)"> <summary> Sets the instance's hypervisor type. </summary> <param name="hypervisor">The instance's hypervisor type.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetHypervisor"> <summary> Checks if the Hypervisor property is set. </summary> <returns>true if the Hypervisor property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithNetworkInterfaceSet(Amazon.EC2.Model.InstanceNetworkInterface[])"> <summary> Sets the network interfaces for the instance. </summary> <param name="list">Collection of InstanceNetworkInterface items</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetNetworkInterfaceSet"> <summary> Checks if the NetworkInterfaceSet property is set </summary> <returns>true if the NetworkInterfaceSet property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithEbsOptimized(System.Boolean)"> <summary> Sets whether to use the EBS IOPS optimized option. </summary> <param name="ebsOptimized">Specifies whether to use the EBS IOPS optimized option.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetEbsOptimized"> <summary> Checks if EbsOptimized property is set </summary> <returns>true if EbsOptimized property is set</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.WithInstanceProfile(Amazon.EC2.Model.IAMInstanceProfile)"> <summary> Sets the IAM Instance Profile (IIP) associated with the instance. </summary> <param name="instanceProfile">An Identity and Access Management Instance Profile</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.RunningInstance.IsSetInstanceProfile"> <summary> Checks if the InstanceProfile property is set </summary> <returns>true if the InstanceProfile property is set</returns> </member> <member name="P:Amazon.EC2.Model.RunningInstance.InstanceId"> <summary> Unique ID of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.ImageId"> <summary> Image ID of the AMI used to launch the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.InstanceState"> <summary> The current state of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.PrivateDnsName"> <summary> The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This element remains empty until the instance enters a running state </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.PublicDnsName"> <summary> The public DNS name assigned to the instance. This DNS name is contactable from outside the Amazon EC2 network. This element remains empty until the instance enters a running state </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.StateTransitionReason"> <summary> Reason for the most recent state transition. This might be an empty string. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.KeyName"> <summary> Name of a key pair associated with this instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.AmiLaunchIndex"> <summary> The AMI launch index, which can be used to find this instance within the launch group. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.ProductCode"> <summary> Product codes attached to this instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.ProductCodes"> <summary> Product codes attached to this instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.InstanceType"> <summary> The instance type. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.LaunchTime"> <summary> The time the instance launched. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.Placement"> <summary> The location where the instance launched. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.KernelId"> <summary> Kernel associated with this instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.RamdiskId"> <summary> RAM disk associated with this instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.Platform"> <summary> Platform of the instance (e.g., Windows). </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.Monitoring"> <summary> Monitoring configuration for the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.SubnetId"> <summary> The subnet ID in which the instance is running (Amazon Virtual Private Cloud). </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.VpcId"> <summary> The VPC in which the instance is running (Amazon Virtual Private Cloud). </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.PrivateIpAddress"> <summary> The private IP address that is assigned to the instance (Amazon VPC). </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.IpAddress"> <summary> The IP address of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.SourceDestCheck"> <summary> Whether source/destination checking is enabled on the instance. </summary> <remarks> A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, go to NAT Instances in the Amazon Virtual Private Cloud User Guide. </remarks> </member> <member name="P:Amazon.EC2.Model.RunningInstance.GroupId"> <summary> A list of VPC security group names the instance is in. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.GroupName"> <summary> A list of VPC security group IDs the instance is in. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.StateReason"> <summary> The reason for the state change. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.Architecture"> <summary> The architecture of the image. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.RootDeviceType"> <summary> The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.RootDeviceName"> <summary> The root device name (e.g., /dev/sda1). </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.BlockDeviceMapping"> <summary> Block device mapping configuration. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.InstanceLifecycle"> <summary> Whether this is a Spot Instance. Valid values: spot | blank (no value) </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.SpotInstanceRequestId"> <summary> The ID of the Spot Instance request that started this instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.License"> <summary> The active license that is in use and attached to the Amazon EC2 instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.VirtualizationType"> <summary> Whether the Amazon EC2 instance is a hardware virtual machine (HVM) or a para-virtual machine (PVM). </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.ClientToken"> <summary> The idempotency token provided when you launched the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.Tag"> <summary> A list of tags for the RunningInstance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.Hypervisor"> <summary> The instance's hypervisor type. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.NetworkInterfaceSet"> <summary> The network interfaces for the instance. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.EbsOptimized"> <summary> Whether to use the EBS IOPS optimized option. </summary> </member> <member name="P:Amazon.EC2.Model.RunningInstance.InstanceProfile"> <summary> The IAM Instance Profile (IIP) associated with the instance. </summary> </member> <member name="T:Amazon.EC2.Model.S3Storage"> <summary> S3 storage configuration </summary> </member> <member name="M:Amazon.EC2.Model.S3Storage.WithBucket(System.String)"> <summary> Sets the bucket in which to store the AMI. </summary> <param name="bucket">The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.IsSetBucket"> <summary> Checks if Bucket property is set </summary> <returns>true if Bucket property is set</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.WithPrefix(System.String)"> <summary> Sets the beginning of the file name of the AMI. </summary> <param name="prefix">Specifies the beginning of the file name of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.IsSetPrefix"> <summary> Checks if Prefix property is set </summary> <returns>true if Prefix property is set</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.WithAWSAccessKeyId(System.String)"> <summary> Sets the Access Key ID of the owner of the Amazon S3 bucket. </summary> <param name="AWSAccessKeyId">The Access Key ID of the owner of the Amazon S3 bucket.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.IsSetAWSAccessKeyId"> <summary> Checks if AWSAccessKeyId property is set </summary> <returns>true if AWSAccessKeyId property is set</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.WithUploadPolicy(System.String)"> <summary> Sets a Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf. </summary> <param name="uploadPolicy">A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.IsSetUploadPolicy"> <summary> Checks if UploadPolicy property is set </summary> <returns>true if UploadPolicy property is set</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.WithUploadPolicySignature(System.String)"> <summary> Sets the signature of the Base64 encoded JSON document. </summary> <param name="uploadPolicySignature">The signature of the Base64 encoded JSON document.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.S3Storage.IsSetUploadPolicySignature"> <summary> Checks if UploadPolicySignature property is set </summary> <returns>true if UploadPolicySignature property is set</returns> </member> <member name="P:Amazon.EC2.Model.S3Storage.Bucket"> <summary> The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error. </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.Prefix"> <summary> The beginning of the file name of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.AWSAccessKeyId"> <summary> The Access Key ID of the owner of the Amazon S3 bucket. </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.UploadPolicy"> <summary> A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on the user's behalf. </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.UploadPolicySignature"> <summary> The signature of the Base64 encoded JSON document. </summary> </member> <member name="T:Amazon.EC2.Model.SecurityGroup"> <summary> Security group </summary> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithOwnerId(System.String)"> <summary> Sets the AWS Access Key ID of the owner of the security group. </summary> <param name="ownerId">AWS Access Key ID of the owner of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetOwnerId"> <summary> Checks if OwnerId property is set </summary> <returns>true if OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithVpcId(System.String)"> <summary> Sets the ID of the VPC to which the group belongs. </summary> <param name="vpcId">The vpc to which the group belongs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithGroupId(System.String)"> <summary> Sets the ID of the security group. </summary> <param name="groupId">Id of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithGroupName(System.String)"> <summary> Sets the name of the security group. </summary> <param name="groupName">Name of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithGroupDescription(System.String)"> <summary> Sets the description of the security group. </summary> <param name="groupDescription">Description of the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetGroupDescription"> <summary> Checks if GroupDescription property is set </summary> <returns>true if GroupDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags for the security group. </summary> <param name="list">A list of tags for the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithIpPermission(Amazon.EC2.Model.IpPermission[])"> <summary> Sets the IP permissions associated with the security group. </summary> <param name="list">Set of IP permissions associated with the security group.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetIpPermission"> <summary> Checks if IpPermission property is set </summary> <returns>true if IpPermission property is set</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.WithIpPermissionsEgress(Amazon.EC2.Model.IpPermission[])"> <summary> Sets the outbound rules associated with the security group (for VPC security groups). </summary> <param name="list">A list of outbound rules associated with the security group (for VPC security groups).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SecurityGroup.IsSetIpPermissionsEgress"> <summary> Checks if IpPermissionsEgress property is set </summary> <returns>true if IpPermissionsEgress property is set</returns> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.OwnerId"> <summary> AWS Access Key ID of the owner of the security group. </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.VpcId"> <summary> The ID of the VPC to which the group belongs. </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.GroupId"> <summary> ID of the security group. </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.GroupName"> <summary> Name of the security group. </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.GroupDescription"> <summary> Description of the security group. </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.Tag"> <summary> A list of tags for the security group. </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.IpPermission"> <summary> Set of IP permissions associated with the security group. </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.IpPermissionsEgress"> <summary> A list of outbound rules associated with the security group (for VPC security groups). </summary> </member> <member name="T:Amazon.EC2.Model.Snapshot"> <summary> A Snapshot of an EBS volume. </summary> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithSnapshotId(System.String)"> <summary> Sets the ID of the snapshot. </summary> <param name="snapshotId">The ID of the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithVolumeId(System.String)"> <summary> Sets the ID of the volume from which the snapshot was created. </summary> <param name="volumeId">The ID of the volume from which the snapshot was created.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithStatus(System.String)"> <summary> Sets the snapshot state. </summary> <param name="status">Snapshot state - can be one of pending | completed | error</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithStartTime(System.String)"> <summary> Sets the time stamp when the snapshot was initiated. </summary> <param name="startTime">Time stamp when the snapshot was initiated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetStartTime"> <summary> Checks if StartTime property is set </summary> <returns>true if StartTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithProgress(System.String)"> <summary> Sets the progress of the snapshot, in percentage. </summary> <param name="progress">The progress of the snapshot, in percentage.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetProgress"> <summary> Checks if Progress property is set </summary> <returns>true if Progress property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithOwnerId(System.String)"> <summary> Sets the AWS Access Key ID of the user who owns the snapshot. </summary> <param name="ownerId">AWS Access Key ID of the user who owns the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetOwnerId"> <summary> Checks if OwnerId property is set </summary> <returns>true if OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithVolumeSize(System.String)"> <summary> Sets the size of the volume </summary> <param name="volumeSize">Size of the volume</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetVolumeSize"> <summary> Checks if VolumeSize property is set </summary> <returns>true if VolumeSize property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithDescription(System.String)"> <summary> Sets the description of the snapshot. </summary> <param name="description">Description of the snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithOwnerAlias(System.String)"> <summary> Sets the AWS account alias (amazon, self, etc.) or AWS account ID that owns the AMI. </summary> <param name="ownerAlias">OwnerAlias property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetOwnerAlias"> <summary> Checks if OwnerAlias property is set </summary> <returns>true if OwnerAlias property is set</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags for the Snapshot. </summary> <param name="list">A list of tags for the Snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Snapshot.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.Snapshot.SnapshotId"> <summary> The ID of the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.VolumeId"> <summary> The ID of the volume from which the snapshot was created. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Status"> <summary> Snapshot state. Valid values: pending | completed | error </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.StartTime"> <summary> Time stamp when the snapshot was initiated. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Progress"> <summary> The progress of the snapshot, in percentage. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.OwnerId"> <summary> AWS Access Key ID of the user who owns the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.VolumeSize"> <summary> Size of the volume </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Description"> <summary> Description of the snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.OwnerAlias"> <summary> The AWS account alias (amazon, self, etc.) or AWS account ID that owns the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Tag"> <summary> A list of tags for the Snapshot. </summary> </member> <member name="T:Amazon.EC2.Model.SnapshotAttribute"> <summary> Snapshot Attribute </summary> </member> <member name="M:Amazon.EC2.Model.SnapshotAttribute.WithSnapshotId(System.String)"> <summary> Sets the ID of the Amazon EBS snapshot. </summary> <param name="snapshotId">The ID of the Amazon EBS snapshot.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SnapshotAttribute.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.SnapshotAttribute.WithCreateVolumePermission(Amazon.EC2.Model.CreateVolumePermission[])"> <summary> Sets the list of create volume permissions </summary> <param name="list">list of create volume permissions</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SnapshotAttribute.IsSetCreateVolumePermission"> <summary> Checks if CreateVolumePermission property is set </summary> <returns>true if CreateVolumePermission property is set</returns> </member> <member name="M:Amazon.EC2.Model.SnapshotAttribute.WithProductCodes(Amazon.EC2.Model.ProductCode[])"> <summary> Sets the product codes associated with the snapshot. </summary> <param name="list">Product codes.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SnapshotAttribute.IsSetProductCodes"> <summary> Checks if ProductCodes property is set </summary> <returns>true if ProductCodes property is set</returns> </member> <member name="P:Amazon.EC2.Model.SnapshotAttribute.SnapshotId"> <summary> The ID of the Amazon EBS snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotAttribute.CreateVolumePermission"> <summary> List of create volume permissions </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotAttribute.ProductCodes"> <summary> The product codes associated with the snapshot. </summary> </member> <member name="T:Amazon.EC2.Model.SpotDatafeedSubscription"> <summary> Spot Datafeed subscription. </summary> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.WithOwnerId(System.String)"> <summary> Sets the AWS account ID associated with the subscription. </summary> <param name="ownerId">The AWS account ID associated with the subscription.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.IsSetOwnerId"> <summary> Checks if OwnerId property is set </summary> <returns>true if OwnerId property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.WithBucket(System.String)"> <summary> Sets the Amazon S3 bucket where the Spot Instance datafeed is located. </summary> <param name="bucket">The Amazon S3 bucket where the Spot Instance datafeed is located.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.IsSetBucket"> <summary> Checks if Bucket property is set </summary> <returns>true if Bucket property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.WithPrefix(System.String)"> <summary> Sets the prefix prepended to the datafeed files. </summary> <param name="prefix">The prefix prepended to the datafeed files.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.IsSetPrefix"> <summary> Checks if Prefix property is set </summary> <returns>true if Prefix property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.WithState(System.String)"> <summary> Sets the state of the Spot Instance request. </summary> <param name="state">The state of the Spot Instance request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.WithFault(Amazon.EC2.Model.SpotInstanceStateFault)"> <summary> Sets the fault details for the Spot Instance request, if any. </summary> <param name="fault">Fault details for the Spot Instance request, if any.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotDatafeedSubscription.IsSetFault"> <summary> Checks if Fault property is set </summary> <returns>true if Fault property is set</returns> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.OwnerId"> <summary> The AWS account ID associated with the subscription. </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.Bucket"> <summary> The Amazon S3 bucket where the Spot Instance datafeed is located. </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.Prefix"> <summary> The prefix prepended to the datafeed files. </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.State"> <summary> The state of the Spot Instance request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.Fault"> <summary> Fault details for the Spot Instance request, if any. </summary> </member> <member name="T:Amazon.EC2.Model.SpotInstanceRequest"> <summary> A Spot Instance request </summary> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithSpotInstanceRequestId(System.String)"> <summary> Sets the ID of the SpotInstanceRequest. </summary> <param name="spotInstanceRequestId">The ID of the SpotInstanceRequest.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetSpotInstanceRequestId"> <summary> Checks if SpotInstanceRequestId property is set </summary> <returns>true if SpotInstanceRequestId property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithSpotPrice(System.String)"> <summary> Sets the maximum price you will pay to launch one or more Spot Instances. </summary> <param name="spotPrice">Specifies the maximum price you will pay to launch one or more Spot Instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetSpotPrice"> <summary> Checks if SpotPrice property is set </summary> <returns>true if SpotPrice property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithType(System.String)"> <summary> Sets the instance type (eg. m1.small) </summary> <param name="type">The instance type (eg. m1.small)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithState(System.String)"> <summary> Sets the state of the Spot Instance request. </summary> <param name="state">The state of the Spot Instance request. Valid values: open | closed | cancelled | failed</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetState"> <summary> Checks if State property is set </summary> <returns>true if State property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithFault(Amazon.EC2.Model.SpotInstanceStateFault)"> <summary> Sets the fault details for the Spot Instance request. </summary> <param name="fault">Fault details for the Spot Instance request, if any.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetFault"> <summary> Checks if Fault property is set </summary> <returns>true if Fault property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithStatus(Amazon.EC2.Model.SpotInstanceStatusMessage)"> <summary> Sets the status details for the Spot Instance request. </summary> <param name="status">Status details for the Spot Instance request, if any.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithValidFrom(System.String)"> <summary> Sets the start date of the request. </summary> <param name="validFrom">Start date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetValidFrom"> <summary> Checks if ValidFrom property is set </summary> <returns>true if ValidFrom property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithValidUntil(System.String)"> <summary> Sets the end date of the request. </summary> <param name="validUntil">End date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetValidUntil"> <summary> Checks if ValidUntil property is set </summary> <returns>true if ValidUntil property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithLaunchGroup(System.String)"> <summary> Sets the instance launch group. </summary> <param name="launchGroup">Sets the instance launch group. Launch groups are Spot Instances that launch and terminate together.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetLaunchGroup"> <summary> Checks if LaunchGroup property is set </summary> <returns>true if LaunchGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithAvailabilityZoneGroup(System.String)"> <summary> Sets the Availability Zone group. </summary> <param name="availabilityZoneGroup">Specifies the Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetAvailabilityZoneGroup"> <summary> Checks if AvailabilityZoneGroup property is set </summary> <returns>true if AvailabilityZoneGroup property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithLaunchSpecification(Amazon.EC2.Model.LaunchSpecification)"> <summary> Sets the additional launch instance information. </summary> <param name="launchSpecification">Specifies additional launch instance information.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetLaunchSpecification"> <summary> Checks if LaunchSpecification property is set </summary> <returns>true if LaunchSpecification property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithInstanceId(System.String)"> <summary> Sets the instance associated with the Spot Instance Request. </summary> <param name="instanceId">The instance associated with the Spot Instance Request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithCreateTime(System.String)"> <summary> Sets the time stamp when the Spot Instance request was fulfilled. </summary> <param name="createTime">Time stamp when the Spot Instance request was fulfilled.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetCreateTime"> <summary> Checks if CreateTime property is set </summary> <returns>true if CreateTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithProductDescription(System.String)"> <summary> Sets the product description associated with the Spot Instance. </summary> <param name="productDescription">The product description associated with the Spot Instance.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetProductDescription"> <summary> Checks if ProductDescription property is set </summary> <returns>true if ProductDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags for the specified resources. </summary> <param name="list">A list of tags for the specified resources.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.WithLaunchedAvailabilityZone(System.String)"> <summary> Sets the Availability Zone in which the bid is launched. </summary> <param name="launchedAvailabilityZone">The Availability Zone in which the bid is launched.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceRequest.IsSetLaunchedAvailabilityZone"> <summary> Checks if LaunchedAvailabilityZone property is set </summary> <returns>true if LaunchedAvailabilityZone property is set</returns> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.SpotInstanceRequestId"> <summary> The ID of the SpotInstanceRequest. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.SpotPrice"> <summary> The maximum price you will pay to launch one or more Spot Instances. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Type"> <summary> The instance type (eg. m1.small) </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.State"> <summary> The state of the Spot Instance request. Valid values: open | closed | cancelled | failed </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Fault"> <summary> Fault details for the Spot Instance request, if any. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Status"> <summary> Status details for the Spot Instance request, if any. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.ValidFrom"> <summary> Start date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.ValidUntil"> <summary> End date of the request. If this is a one-time request, the request remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, it remains active until it expires or is canceled. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.LaunchGroup"> <summary> The instance launch group. Launch groups are Spot Instances that launch and terminate together. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.AvailabilityZoneGroup"> <summary> The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.LaunchSpecification"> <summary> Additional launch instance information. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.InstanceId"> <summary> The instance associated with the Spot Instance Request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.CreateTime"> <summary> Time stamp when the Spot Instance request was fulfilled. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.ProductDescription"> <summary> The product description associated with the Spot Instance. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Tag"> <summary> A list of tags for the specified resources. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.LaunchedAvailabilityZone"> <summary> The Availability Zone in which the bid is launched. </summary> </member> <member name="T:Amazon.EC2.Model.SpotInstanceStateFault"> <summary> Fault details for a Spot Instance request. </summary> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStateFault.WithCode(System.String)"> <summary> Sets the reason code for the Spot Instance request fault. </summary> <param name="code">The reason code for the Spot Instance request fault</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStateFault.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStateFault.WithMessage(System.String)"> <summary> Sets the message for the Spot Instance request fault. </summary> <param name="message">The message for the Spot Instance request fault.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStateFault.IsSetMessage"> <summary> Checks if Message property is set </summary> <returns>true if Message property is set</returns> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStateFault.Code"> <summary> The reason code for the Spot Instance request fault. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStateFault.Message"> <summary> The message for the Spot Instance request fault. </summary> </member> <member name="T:Amazon.EC2.Model.SpotInstanceStatusMessage"> <summary> Status details for the Spot Instance request. </summary> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStatusMessage.WithCode(System.String)"> <summary> Sets the code for the Spot Instance request status. </summary> <param name="code">The code for the Spot Instance request status</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStatusMessage.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStatusMessage.WithUpdateTime(System.String)"> <summary> Sets the time of the most recent update for the status. </summary> <param name="updateTime">The time of the most recent update for the status.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStatusMessage.IsSetUpdateTime"> <summary> Checks if UpdateTime property is set </summary> <returns>true if UpdateTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStatusMessage.WithMessage(System.String)"> <summary> Sets the message for the Spot Instance request status. </summary> <param name="message">The message for the Spot Instance request status.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotInstanceStatusMessage.IsSetMessage"> <summary> Checks if Message property is set </summary> <returns>true if Message property is set</returns> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStatusMessage.Code"> <summary> The code for the Spot Instance request status. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStatusMessage.UpdateTime"> <summary> The time of the most recent update for the status. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStatusMessage.Message"> <summary> The message for the Spot Instance request status. </summary> </member> <member name="T:Amazon.EC2.Model.SpotPriceHistory"> <summary> A single Spot Price history data point. </summary> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.WithInstanceType(System.String)"> <summary> Sets the instance type. </summary> <param name="instanceType">The instance type.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.IsSetInstanceType"> <summary> Checks if InstanceType property is set </summary> <returns>true if InstanceType property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.WithProductDescription(System.String)"> <summary> Sets the description of the AMI. </summary> <param name="productDescription">The description of the AMI.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.IsSetProductDescription"> <summary> Checks if ProductDescription property is set </summary> <returns>true if ProductDescription property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.WithSpotPrice(System.String)"> <summary> Sets the price paid to launch one or more instances. </summary> <param name="spotPrice">Specifies the price paid to launch one or more instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.IsSetSpotPrice"> <summary> Checks if SpotPrice property is set </summary> <returns>true if SpotPrice property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.WithTimestamp(System.String)"> <summary> Sets the creation timestamp of the request. </summary> <param name="timestamp">Specifies the creation timestamp of the request.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.IsSetTimestamp"> <summary> Checks if Timestamp property is set </summary> <returns>true if Timestamp property is set</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone. </summary> <param name="availabilityZone">The Availability Zone.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.SpotPriceHistory.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="P:Amazon.EC2.Model.SpotPriceHistory.InstanceType"> <summary> The instance type. </summary> </member> <member name="P:Amazon.EC2.Model.SpotPriceHistory.ProductDescription"> <summary> The description of the AMI. </summary> </member> <member name="P:Amazon.EC2.Model.SpotPriceHistory.SpotPrice"> <summary> The price paid to launch one or more instances. </summary> </member> <member name="P:Amazon.EC2.Model.SpotPriceHistory.Timestamp"> <summary> The creation timestamp of the request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotPriceHistory.AvailabilityZone"> <summary> The Availability Zone. </summary> </member> <member name="T:Amazon.EC2.Model.StartInstancesRequest"> <summary> Starts an Amazon EBS-backed AMI that you've previously stopped. </summary> <remarks> <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, we charge 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> </remarks> </member> <member name="M:Amazon.EC2.Model.StartInstancesRequest.WithInstanceId(System.String[])"> <summary> Sets the instance ID. </summary> <param name="list">The instance ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.StartInstancesRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.StartInstancesRequest.InstanceId"> <summary> The instance ID. </summary> </member> <member name="T:Amazon.EC2.Model.StartInstancesResponse"> <summary> Information returned by the StartInstances request. </summary> </member> <member name="M:Amazon.EC2.Model.StartInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.StartInstancesResponse.IsSetStartInstancesResult"> <summary> Checks if StartInstancesResult property is set </summary> <returns>true if StartInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.StartInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.StartInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.StartInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.StartInstancesResponse.StartInstancesResult"> <summary> Gets and sets the StartInstancesResult property. Result of a StartInstances request. </summary> </member> <member name="T:Amazon.EC2.Model.StartInstancesResult"> <summary> Result of a StartInstances request. </summary> </member> <member name="M:Amazon.EC2.Model.StartInstancesResult.IsSetStartingInstances"> <summary> Checks if StartingInstances property is set </summary> <returns>true if StartingInstances property is set</returns> </member> <member name="M:Amazon.EC2.Model.StartInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.StartInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.StartInstancesResult.StartingInstances"> <summary> Gets and sets the StartingInstances property. </summary> </member> <member name="T:Amazon.EC2.Model.StateReason"> <summary> Reason for the state change. </summary> </member> <member name="M:Amazon.EC2.Model.StateReason.WithCode(System.String)"> <summary> Sets the reason code for the state change. </summary> <param name="code">Reason code for the state change.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.StateReason.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.StateReason.WithMessage(System.String)"> <summary> Sets the message for the state change. </summary> <param name="message">Message for the state change.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.StateReason.IsSetMessage"> <summary> Checks if Message property is set </summary> <returns>true if Message property is set</returns> </member> <member name="P:Amazon.EC2.Model.StateReason.Code"> <summary> Reason code for the state change. </summary> </member> <member name="P:Amazon.EC2.Model.StateReason.Message"> <summary> Message for the state change. </summary> </member> <member name="T:Amazon.EC2.Model.StopInstancesRequest"> <summary> Container for the parameters to the StopInstances operation. <para>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> <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> </member> <member name="M:Amazon.EC2.Model.StopInstancesRequest.WithInstanceId(System.String[])"> <summary> Sets the instance ID. </summary> <param name="list">The instance ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesRequest.WithForce(System.Boolean)"> <summary> Sets whether to force the instance to stop. </summary> <param name="force">Forces the instance to stop. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesRequest.IsSetForce"> <summary> Checks if Force property is set </summary> <returns>true if Force property is set</returns> </member> <member name="P:Amazon.EC2.Model.StopInstancesRequest.InstanceId"> <summary> The instance ID. </summary> </member> <member name="P:Amazon.EC2.Model.StopInstancesRequest.Force"> <summary> Whether to force the instance to stop. </summary> <remarks> The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. </remarks> </member> <member name="T:Amazon.EC2.Model.StopInstancesResponse"> <summary> Information returned by a StopInstances request. </summary> </member> <member name="M:Amazon.EC2.Model.StopInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesResponse.IsSetStopInstancesResult"> <summary> Checks if StopInstancesResult property is set </summary> <returns>true if StopInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.StopInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.StopInstancesResponse.StopInstancesResult"> <summary> Gets and sets the StopInstancesResult property. Result of a StopInstances request. </summary> </member> <member name="T:Amazon.EC2.Model.StopInstancesResult"> <summary> Result of a StopInstances request. </summary> </member> <member name="M:Amazon.EC2.Model.StopInstancesResult.IsSetStoppingInstances"> <summary> Checks if StoppingInstances property is set </summary> <returns>true if StoppingInstances property is set</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.StopInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.StopInstancesResult.StoppingInstances"> <summary> Gets and sets the StoppingInstances property. </summary> </member> <member name="T:Amazon.EC2.Model.Storage"> <summary> Storage configuration </summary> </member> <member name="M:Amazon.EC2.Model.Storage.WithS3(Amazon.EC2.Model.S3Storage)"> <summary> Sets the S3 Storage </summary> <param name="s3">S3 Storage</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Storage.IsSetS3"> <summary> Checks if S3 property is set </summary> <returns>true if S3 property is set</returns> </member> <member name="P:Amazon.EC2.Model.Storage.S3"> <summary> S3 Storage </summary> </member> <member name="T:Amazon.EC2.Model.Subnet"> <summary> Subnet </summary> </member> <member name="M:Amazon.EC2.Model.Subnet.WithSubnetId(System.String)"> <summary> Sets the subnet's ID </summary> <param name="subnetId">The subnet's ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetSubnetId"> <summary> Checks if SubnetId property is set </summary> <returns>true if SubnetId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithSubnetState(System.String)"> <summary> Sets the current state of the subnet (pending or available). </summary> <param name="subnetState">The current state of the subnet (pending or available).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetSubnetState"> <summary> Checks if SubnetState property is set </summary> <returns>true if SubnetState property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithVpcId(System.String)"> <summary> Sets the ID of the VPC the subnet is in </summary> <param name="vpcId">The ID of the VPC the subnet is in</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithCidrBlock(System.String)"> <summary> Sets the CIDR block assigned to the subnet </summary> <param name="cidrBlock">The CIDR block assigned to the subnet</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetCidrBlock"> <summary> Checks if CidrBlock property is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithAvailableIpAddressCount(System.Decimal)"> <summary> Sets the number of unused IP addresses in the subnet. </summary> <param name="availableIpAddressCount">The number of unused IP addresses in the subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetAvailableIpAddressCount"> <summary> Checks if AvailableIpAddressCount property is set </summary> <returns>true if AvailableIpAddressCount property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone the subnet is in. </summary> <param name="availabilityZone">The Availability Zone the subnet is in.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithDefaultForAz(System.Boolean)"> <summary> Sets whether the subnet is default for the availability zone. </summary> <param name="defaultForAz">Whether the subnet is default for the availability zone.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetDefaultForAz"> <summary> Checks if the DefaultForAz property is set </summary> <returns>true if the DefaultForAz property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithMapPublicIpOnLaunch(System.Boolean)"> <summary> Sets whether to map the public IP on launch. </summary> <param name="mapPublicIpOnLaunch">Whether to map the public IP on launch.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetMapPublicIpOnLaunch"> <summary> Checks if the MapPublicIpOnLaunch property is set </summary> <returns>true if the MapPublicIpOnLaunch property is set</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets tags for the Subnet. </summary> <param name="list">A list of tags for the Subnet.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Subnet.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.Subnet.SubnetId"> <summary> The subnet's ID </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.SubnetState"> <summary> The current state of the subnet (pending or available). </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.VpcId"> <summary> The ID of the VPC the subnet is in </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.CidrBlock"> <summary> The CIDR block assigned to the subnet </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.AvailableIpAddressCount"> <summary> The number of unused IP addresses in the subnet. </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.AvailabilityZone"> <summary> The Availability Zone the subnet is in. </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.DefaultForAz"> <summary> Whether the subnet is default for the availability zone. </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.MapPublicIpOnLaunch"> <summary> Whether to map the public IP on launch. </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.Tag"> <summary> A list of tags for the Subnet. </summary> </member> <member name="T:Amazon.EC2.Model.Tag"> <summary> Metadata to associate with Amazon EC2 resources. Each tag consists of a user-defined key and value. Use tags to categorize EC2 resources, such as by purpose, owner, or environment. </summary> </member> <member name="M:Amazon.EC2.Model.Tag.WithKey(System.String)"> <summary> Sets the tag's key. </summary> <param name="key">The tag's key.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Tag.IsSetKey"> <summary> Checks if Key property is set </summary> <returns>true if Key property is set</returns> </member> <member name="M:Amazon.EC2.Model.Tag.WithValue(System.String)"> <summary> Sets the tag's value. </summary> <param name="value">The tag's value.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Tag.IsSetValue"> <summary> Checks if Value property is set </summary> <returns>true if Value property is set</returns> </member> <member name="P:Amazon.EC2.Model.Tag.Key"> <summary> The tag's key. </summary> </member> <member name="P:Amazon.EC2.Model.Tag.Value"> <summary> The tag's value. </summary> </member> <member name="T:Amazon.EC2.Model.TerminateInstancesRequest"> <summary> Container for the parameters to the TerminateInstances operation. <para>Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.</para> <para>Terminated instances remain visible after termination (for approximately one hour).</para> <para>By default, Amazon EC2 deletes all Amazon 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, 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/TroubleshootingInstancesShuttingDown.html" >Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> .</para> </summary> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesRequest.WithInstanceId(System.String[])"> <summary> Sets instance IDs to terminate. </summary> <param name="list">Instance ID to terminate.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.TerminateInstancesRequest.InstanceId"> <summary> Instance IDs to terminate. </summary> </member> <member name="T:Amazon.EC2.Model.TerminateInstancesResponse"> <summary> Terminate Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesResponse.IsSetTerminateInstancesResult"> <summary> Checks if TerminateInstancesResult property is set </summary> <returns>true if TerminateInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.TerminateInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.TerminateInstancesResponse.TerminateInstancesResult"> <summary> Gets and sets the TerminateInstancesResult property. Terminate Instances Result </summary> </member> <member name="T:Amazon.EC2.Model.TerminateInstancesResult"> <summary> Terminate Instances Result </summary> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesResult.IsSetTerminatingInstance"> <summary> Checks if TerminatingInstance property is set </summary> <returns>true if TerminatingInstance property is set</returns> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.TerminateInstancesResult.TerminatingInstance"> <summary> Gets and sets the TerminatingInstance property. List of terminating instances </summary> </member> <member name="T:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest"> <summary> Unassigns one or more secondary private IP addresses from a network interface in Amazon VPC. This command is only available in Amazon VPC </summary> </member> <member name="M:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.WithNetworkInterfaceId(System.String)"> <summary> Sets the network interface from which the secondary private IP address will be unassigned. </summary> <param name="networkInterfaceId">Network interface ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.IsSetNetworkInterfaceId"> <summary> Checks if the NetworkInterfaceId property is set </summary> <returns>true if the NetworkInterfaceId property is set</returns> </member> <member name="M:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.WithPrivateIpAddresses(System.Collections.Generic.List{System.String})"> <summary> Sets the secondary private IP addresses that you want to unassign from the network interface. </summary> <param name="privateIpAddresses">List of private IP addresses.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.IsSetPrivateIpAddresses"> <summary> Checks if the PrivateIpAddresses property is set </summary> <returns>true if the PrivateIpAddresses property is set</returns> </member> <member name="P:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.NetworkInterfaceId"> <summary> The network interface from which the secondary private IP address will be unassigned. </summary> </member> <member name="P:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.PrivateIpAddresses"> <summary> The secondary private IP addresses that you want to unassign from the network interface. </summary> </member> <member name="T:Amazon.EC2.Model.UnassignPrivateIpAddressesResponse"> <summary> Unassign Private Ip Addresses Response </summary> </member> <member name="M:Amazon.EC2.Model.UnassignPrivateIpAddressesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.UnassignPrivateIpAddressesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.UnassignPrivateIpAddressesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.UnassignPrivateIpAddressesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="T:Amazon.EC2.Model.UnmonitorInstancesRequest"> <summary> Disables monitoring for a running instance. </summary> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesRequest.WithInstanceId(System.String[])"> <summary> Sets the Instance ID. </summary> <param name="list">Instance ID.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesRequest.IsSetInstanceId"> <summary> Checks if InstanceId property is set </summary> <returns>true if InstanceId property is set</returns> </member> <member name="P:Amazon.EC2.Model.UnmonitorInstancesRequest.InstanceId"> <summary> Instance ID. </summary> </member> <member name="T:Amazon.EC2.Model.UnmonitorInstancesResponse"> <summary> Unmonitor Instances Response </summary> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesResponse.IsSetResponseMetadata"> <summary> Checks if ResponseMetadata property is set </summary> <returns>true if ResponseMetadata property is set</returns> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesResponse.IsSetUnmonitorInstancesResult"> <summary> Checks if UnmonitorInstancesResult property is set </summary> <returns>true if UnmonitorInstancesResult property is set</returns> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesResponse.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesResponse.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.UnmonitorInstancesResponse.ResponseMetadata"> <summary> Gets and sets the ResponseMetadata property. Response Metadata </summary> </member> <member name="P:Amazon.EC2.Model.UnmonitorInstancesResponse.UnmonitorInstancesResult"> <summary> Gets and sets the UnmonitorInstancesResult property. Unmonitor Instances Result </summary> </member> <member name="T:Amazon.EC2.Model.UnmonitorInstancesResult"> <summary> Unmonitor Instances Result </summary> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesResult.IsSetInstanceMonitoring"> <summary> Checks if InstanceMonitoring property is set </summary> <returns>true if InstanceMonitoring property is set</returns> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesResult.ToXML"> <summary> XML Representation of this object </summary> <returns>XML String</returns> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesResult.ToString"> <summary> String Representation of this object. Overrides Object.ToString() </summary> <returns>This object as a string</returns> </member> <member name="P:Amazon.EC2.Model.UnmonitorInstancesResult.InstanceMonitoring"> <summary> Gets and sets the InstanceMonitoring property. Instance monitoring information </summary> </member> <member name="T:Amazon.EC2.Model.UserIdGroupPair"> <summary> Security group and user ID pair. </summary> </member> <member name="M:Amazon.EC2.Model.UserIdGroupPair.WithUserId(System.String)"> <summary> Sets the AWS User ID of an account. </summary> <param name="userId">AWS User ID of an account. Cannot be used when specifying a CIDR IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.UserIdGroupPair.IsSetUserId"> <summary> Checks if UserId property is set </summary> <returns>true if UserId property is set</returns> </member> <member name="M:Amazon.EC2.Model.UserIdGroupPair.WithGroupId(System.String)"> <summary> Sets the AWS Group ID of a Security Group. </summary> <param name="userId">AWS Group ID of a Security Group. Cannot be used when specifying a CIDR IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.UserIdGroupPair.IsSetGroupId"> <summary> Checks if GroupId property is set </summary> <returns>true if GroupId property is set</returns> </member> <member name="M:Amazon.EC2.Model.UserIdGroupPair.WithGroupName(System.String)"> <summary> Sets the name of the security group. </summary> <param name="groupName">Name of the security group. Cannot be used when specifying a CIDR IP address.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.UserIdGroupPair.IsSetGroupName"> <summary> Checks if GroupName property is set </summary> <returns>true if GroupName property is set</returns> </member> <member name="P:Amazon.EC2.Model.UserIdGroupPair.UserId"> <summary> AWS User ID of an account. Cannot be used when specifying a CIDR IP address. </summary> </member> <member name="P:Amazon.EC2.Model.UserIdGroupPair.GroupId"> <summary> AWS Group ID of a Security Group. Cannot be used when specifying a CIDR IP address. </summary> </member> <member name="P:Amazon.EC2.Model.UserIdGroupPair.GroupName"> <summary> Name of the security group. Cannot be used when specifying a CIDR IP address. </summary> </member> <member name="T:Amazon.EC2.Model.Volume"> <summary> Volume description </summary> </member> <member name="M:Amazon.EC2.Model.Volume.WithVolumeId(System.String)"> <summary> Sets the ID of the volume. </summary> <param name="volumeId">The ID of the volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithSize(System.String)"> <summary> Sets the size of the volume, in GiBs. </summary> <param name="size">The size of the volume, in GiBs.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetSize"> <summary> Checks if Size property is set </summary> <returns>true if Size property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithSnapshotId(System.String)"> <summary> Sets the snapshot from which the volume was created. </summary> <param name="snapshotId">Snapshot from which the volume was created (optional).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetSnapshotId"> <summary> Checks if SnapshotId property is set </summary> <returns>true if SnapshotId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone in which the volume was created. </summary> <param name="availabilityZone">Availability Zone in which the volume was created.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithStatus(System.String)"> <summary> Sets the volume state </summary> <param name="status">Volume state</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithCreateTime(System.String)"> <summary> Sets the time stamp when volume creation was initiated. </summary> <param name="createTime">Time stamp when volume creation was initiated.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetCreateTime"> <summary> Checks if CreateTime property is set </summary> <returns>true if CreateTime property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithAttachment(Amazon.EC2.Model.Attachment[])"> <summary> Sets the list of attachments </summary> <param name="list">List of attachments</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetAttachment"> <summary> Checks if Attachment property is set </summary> <returns>true if Attachment property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets a list of tags for the Volume. </summary> <param name="list">A list of tags for the Volume.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithIOPS(System.String)"> <summary> Sets the quantity of desired throughput in IOPS. </summary> <param name="iops">Quantity of desired throughput in IOPS</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetIOPS"> <summary> Checks if IOPS property is set </summary> <returns>True if IOPS property is set</returns> </member> <member name="M:Amazon.EC2.Model.Volume.WithVolumeType(System.String)"> <summary> Sets the volume type. </summary> <param name="volumeType">Volume Type. Constraints: may be either "io1" or "standard". If VolumeType != "io1", IOPS property cannot be set. </param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Volume.IsSetVolumeType"> <summary> Checks if VolumeType property is set </summary> <returns>True if VolumeType property is set</returns> </member> <member name="P:Amazon.EC2.Model.Volume.VolumeId"> <summary> The ID of the volume. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Size"> <summary> The size of the volume, in GiBs. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.SnapshotId"> <summary> Snapshot from which the volume was created. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.AvailabilityZone"> <summary> Availability Zone in which the volume was created. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Status"> <summary> Volume state </summary> </member> <member name="P:Amazon.EC2.Model.Volume.CreateTime"> <summary> Time stamp when volume creation was initiated. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Attachment"> <summary> List of attachments </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Tag"> <summary> A list of tags for the Volume. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.IOPS"> <summary> Quantity of desired throughput in IOPS. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.VolumeType"> <summary> The volume type. This can be <c>gp2</c> for General Purpose (SSD) volumes, <c>io1</c> for Provisioned IOPS (SSD) volumes, or <c>standard</c> for Magnetic volumes. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>standard, io1, gp2</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatus"> <summary> Volume Status </summary> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.IsSetVolumeId"> <summary> Checks if VolumeId property is set </summary> <returns>true if VolumeId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.WithVolumeId(System.String)"> <summary> Sets the volume ID </summary> <param name="volumeId">The new volume id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone of the volume </summary> <param name="availabilityZone">The new availability zone</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.IsSetVolumeStatusInfo"> <summary> Checks if VolumeStatusInfo property is set </summary> <returns>true if VolumeStatusInfo property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.WithVolumeStatusInfo(Amazon.EC2.Model.VolumeStatusInfo)"> <summary> Sets the status of the volume </summary> <param name="volumeStatusInfo">The new VolumeStatusInfo</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.IsSetVolumeStatusEvent"> <summary> Checks if VolumeStatusEvent property is set </summary> <returns>true if VolumeStatusEvent property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.WithVolumeStatusEvent(Amazon.EC2.Model.VolumeStatusEvent[])"> <summary> Sets a list of events associated with the volume </summary> <param name="list">The new VolumeStatusEvent</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.IsSetVolumeStatusAction"> <summary> Checks if VolumeStatusAction property is set </summary> <returns>true if VolumeStatusAction property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatus.WithVolumeStatusAction(Amazon.EC2.Model.VolumeStatusAction[])"> <summary> Sets a list of actions associated with the volume </summary> <param name="list">The new VolumeStatusAction</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.VolumeStatus.VolumeId"> <summary> The volume ID </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatus.AvailabilityZone"> <summary> Availability Zone of the volume </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatus.VolumeStatusInfo"> <summary> Status of the volume </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatus.VolumeStatusEvent"> <summary> A list of events associated with the volume </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatus.VolumeStatusAction"> <summary> A list of actions associated with the volume </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusAction"> <summary> Volume Status Action </summary> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.IsSetCode"> <summary> Checks if Code property is set </summary> <returns>true if Code property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.WithCode(System.String)"> <summary> Sets the code identifying the action. </summary> <param name="code">The new code</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.IsSetEventId"> <summary> Checks if EventId property is set </summary> <returns>true if EventId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.WithEventId(System.String)"> <summary> Sets the ID of the event associated with this action. </summary> <param name="eventId">The new event id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.IsSetEventType"> <summary> Checks if EventType property is set </summary> <returns>true if EventType property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.WithEventType(System.String)"> <summary> Sets the event type associated with this action. </summary> <param name="eventType">The new event type</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusAction.WithDescription(System.String)"> <summary> Sets a description of the action. </summary> <param name="description">The new description</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.Code"> <summary> The code identifying the action. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.EventId"> <summary> The ID of the event associated with this action. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.EventType"> <summary> The event type associated with this action. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.Description"> <summary> A description of the action. </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusDetail"> <summary> Volume Status Detail </summary> </member> <member name="M:Amazon.EC2.Model.VolumeStatusDetail.IsSetName"> <summary> Checks if Name property is set </summary> <returns>true if Name property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusDetail.WithName(System.String)"> <summary> Sets the name of the volume's status. </summary> <param name="name">The new name</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusDetail.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusDetail.WithStatus(System.String)"> <summary> Sets the value of the volume's status </summary> <param name="status">The new status</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.VolumeStatusDetail.Name"> <summary> The name of the volume's status. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusDetail.Status"> <summary> The value of the volume's status </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusEvent"> <summary> Volume Status Event </summary> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.IsSetEventType"> <summary> Checks if EventType property is set </summary> <returns>true if EventType property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.WithEventType(System.String)"> <summary> Sets the event's type </summary> <param name="eventType">The new event type</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.IsSetNotBefore"> <summary> Checks if NotBefore property is set </summary> <returns>true if NotBefore property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.WithNotBefore(System.DateTime)"> <summary> Sets the earliest start time of this event </summary> <param name="notBefore">The new NotBefore value</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.IsSetNotAfter"> <summary> Checks if NotAfter property is set </summary> <returns>true if NotAfter property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.WithNotAfter(System.DateTime)"> <summary> Sets the latest end time of this event </summary> <param name="notAfter">The new NotAfter value</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.IsSetEventId"> <summary> Checks if EventId property is set </summary> <returns>true if EventId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.WithEventId(System.String)"> <summary> Sets the ID of this event </summary> <param name="eventId">The new event id</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.IsSetDescription"> <summary> Checks if Description property is set </summary> <returns>true if Description property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusEvent.WithDescription(System.String)"> <summary> Sets the description of this event </summary> <param name="description">The new description</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.EventType"> <summary> The event's type </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.NotBefore"> <summary> The earliest start time of this event </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.NotAfter"> <summary> The latest end time of this event </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.EventId"> <summary> The ID of this event </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.Description"> <summary> The description of this event </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusInfo"> <summary> Volume Status Info </summary> </member> <member name="M:Amazon.EC2.Model.VolumeStatusInfo.IsSetStatus"> <summary> Checks if Status property is set </summary> <returns>true if Status property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusInfo.WithStatus(System.String)"> <summary> Sets the status of the volume </summary> <param name="status">The new status</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusInfo.IsSetVolumeStatusDetail"> <summary> Checks if VolumeStatusDetail property is set </summary> <returns>true if VolumeStatusDetail property is set</returns> </member> <member name="M:Amazon.EC2.Model.VolumeStatusInfo.WithVolumeStatusDetail(Amazon.EC2.Model.VolumeStatusDetail[])"> <summary> Sets the details of the volume status </summary> <param name="list">The new details</param> <returns>this instance</returns> </member> <member name="P:Amazon.EC2.Model.VolumeStatusInfo.Status"> <summary> The status of the volume </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusInfo.VolumeStatusDetail"> <summary> Details of the volume status </summary> </member> <member name="T:Amazon.EC2.Model.Vpc"> <summary> Virtual Private Cloud </summary> </member> <member name="M:Amazon.EC2.Model.Vpc.WithVpcId(System.String)"> <summary> Sets the VPC's ID </summary> <param name="vpcId">The VPC's ID</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.WithVpcState(System.String)"> <summary> Sets the current state of the VPC (pending or available). </summary> <param name="vpcState">The current state of the VPC (pending or available).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.IsSetVpcState"> <summary> Checks if VpcState property is set </summary> <returns>true if VpcState property is set</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.WithCidrBlock(System.String)"> <summary> Sets the CIDR block the VPC covers </summary> <param name="cidrBlock">The CIDR block the VPC covers</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.IsSetCidrBlock"> <summary> Checks if CidrBlock property is set </summary> <returns>true if CidrBlock property is set</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.WithDhcpOptionsId(System.String)"> <summary> Sets the ID of the set of DHCP options ve associated with the VPC (or "default" if the default options are associated with the VPC). </summary> <param name="dhcpOptionsId">The ID of the set of DHCP options you've associated with the VPC (or "default" if the default options are associated with the VPC).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.IsSetDhcpOptionsId"> <summary> Checks if DhcpOptionsId property is set </summary> <returns>true if DhcpOptionsId property is set</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets tags for the VPC. </summary> <param name="list">A list of tags for the Vpc.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.IsSetInstanceTenancy"> <summary> Checks if InstanceTenancy property is set </summary> <returns>true if InstanceTenancy property is set</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.WithInstanceTenancy(System.String)"> <summary> Sets the allowed tenancy of instances launched into the VPC. </summary> <param name="instanceTenancy">The allowed tenancy of instances launched into the VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.WithIsDefault(System.Boolean)"> <summary> Sets whether this is a default VPC. </summary> <param name="isDefault">Whether this is a default VPC.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.Vpc.IsSetIsDefault"> <summary> Checks if the IsDefault property is set </summary> <returns>true if the IsDefault property is set</returns> </member> <member name="P:Amazon.EC2.Model.Vpc.VpcId"> <summary> The VPC's ID </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.VpcState"> <summary> The current state of the VPC (pending or available). </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.CidrBlock"> <summary> The CIDR block the VPC covers </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.DhcpOptionsId"> <summary> The ID of the set of DHCP options you've associated with the VPC (or "default" if the default options are associated with the VPC). </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.Tag"> <summary> A list of tags for the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.InstanceTenancy"> <summary> The allowed tenancy of instances launched into the VPC. </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.IsDefault"> <summary> Whether this is a default VPC. </summary> </member> <member name="T:Amazon.EC2.Model.VpcAttachment"> <summary> VPC Attachment </summary> </member> <member name="M:Amazon.EC2.Model.VpcAttachment.WithVpcId(System.String)"> <summary> Sets the ID of the VPC the VPN gateway is attached to </summary> <param name="vpcId">The ID of the VPC the VPN gateway is attached to</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcAttachment.IsSetVpcId"> <summary> Checks if VpcId property is set </summary> <returns>true if VpcId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpcAttachment.WithVpcAttachmentState(System.String)"> <summary> Sets the current state of the attachment. </summary> <param name="vpcAttachmentState">The current state of the attachment (attaching, attached, detaching, detached)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpcAttachment.IsSetVpcAttachmentState"> <summary> Checks if VpcAttachmentState property is set </summary> <returns>true if VpcAttachmentState property is set</returns> </member> <member name="P:Amazon.EC2.Model.VpcAttachment.VpcId"> <summary> The ID of the VPC the VPN gateway is attached to </summary> </member> <member name="P:Amazon.EC2.Model.VpcAttachment.VpcAttachmentState"> <summary> The current state of the attachment. Valid values: attaching, attached, detaching, detached </summary> </member> <member name="T:Amazon.EC2.Model.VpnConnection"> <summary> VPN Connection </summary> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithVpnConnectionId(System.String)"> <summary> Sets the ID of the VPN connection </summary> <param name="vpnConnectionId">The ID of the VPN connection</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetVpnConnectionId"> <summary> Checks if VpnConnectionId property is set </summary> <returns>true if VpnConnectionId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithVpnConnectionState(System.String)"> <summary> Sets the current state of the VPN connection. </summary> <param name="vpnConnectionState">The current state of the VPN connection (pending, available, deleting, deleted)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetVpnConnectionState"> <summary> Checks if VpnConnectionState property is set </summary> <returns>true if VpnConnectionState property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithCustomerGatewayConfiguration(System.String)"> <summary> Sets the configuration information for the VPN connection's customer gateway. </summary> <param name="customerGatewayConfiguration">Configuration information for the VPN connection's customer gateway (in the native XML format).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetCustomerGatewayConfiguration"> <summary> Checks if CustomerGatewayConfiguration property is set </summary> <returns>true if CustomerGatewayConfiguration property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithType(System.String)"> <summary> Sets the type of VPN connection. </summary> <param name="type">The type of VPN connection (ipsec.1).</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithCustomerGatewayId(System.String)"> <summary> Sets the ID of the customer gateway at your end of the VPN connection. </summary> <param name="customerGatewayId">ID of the customer gateway at your end of the VPN connection</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetCustomerGatewayId"> <summary> Checks if CustomerGatewayId property is set </summary> <returns>true if CustomerGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithVpnGatewayId(System.String)"> <summary> Sets the ID of the VPN gateway at the VPC end of the VPN connection. </summary> <param name="vpnGatewayId">ID of the VPN gateway at the VPC end of the VPN connection</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetVpnGatewayId"> <summary> Checks if VpnGatewayId property is set </summary> <returns>true if VpnGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets the tags assigned to the resource. </summary> <param name="list">Tag property</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithVgwTelemetry(Amazon.EC2.Model.VpnTunnelTelemetry[])"> <summary> Sets the information about the virtual private gateway. </summary> <param name="list">The virtual private gateways.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetVgwTelemetry"> <summary> Checks if VgwTelemetry property is set </summary> <returns>True if the VgwTelemetry property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithStaticRoutesOnly(System.Boolean)"> <summary> Sets whether or not the VPN connection uses static routes only. </summary> <param name="staticRoutesOnly">Static routes only value</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetStaticRoutesOnly"> <summary> Checks if the StaticRoutesOnly property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.WithRoutes(Amazon.EC2.Model.VpnStaticRoute[])"> <summary> Sets the set of static routes associated with a VPN connection. </summary> <param name="list">Set of static routes</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnConnection.IsSetRoutes"> <summary> Checks if the Routes property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.VpnConnection.VpnConnectionId"> <summary> The ID of the VPN connection </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.VpnConnectionState"> <summary> The current state of the VPN connection. Valid values: pending, available, deleting, deleted </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.CustomerGatewayConfiguration"> <summary> Configuration information for the VPN connection's customer gateway. Configuration is in the native XML format. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.Type"> <summary> The type of VPN connection (ipsec.1). </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.CustomerGatewayId"> <summary> ID of the customer gateway at your end of the VPN connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.VpnGatewayId"> <summary> ID of the VPN gateway at the VPC end of the VPN connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.Tag"> <summary> Tags assigned to the resource. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.VgwTelemetry"> <summary> Information about the virtual private gateway. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.StaticRoutesOnly"> <summary> Whether or not the VPN connection uses static routes only. Static routes must be used for devices that do not support BGP. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.Routes"> <summary> Static routes associated with a VPN connection. </summary> </member> <member name="T:Amazon.EC2.Model.VpnGateway"> <summary> VPN Gateway </summary> </member> <member name="M:Amazon.EC2.Model.VpnGateway.WithVpnGatewayId(System.String)"> <summary> Sets the ID of the VPN gateway </summary> <param name="vpnGatewayId">The ID of the VPN gateway</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.IsSetVpnGatewayId"> <summary> Checks if VpnGatewayId property is set </summary> <returns>true if VpnGatewayId property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.WithVpnGatewayState(System.String)"> <summary> Sets the current state of the VPN gateway. </summary> <param name="vpnGatewayState">The current state of the VPN gateway (pending, available, deleting, deleted)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.IsSetVpnGatewayState"> <summary> Checks if VpnGatewayState property is set </summary> <returns>true if VpnGatewayState property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.WithType(System.String)"> <summary> Sets the type of VPN connection the VPN gateway supports </summary> <param name="type">The type of VPN connection the VPN gateway supports (ipsec.1)</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.IsSetType"> <summary> Checks if Type property is set </summary> <returns>true if Type property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.WithAvailabilityZone(System.String)"> <summary> Sets the Availability Zone where the VPN gateway was created </summary> <param name="availabilityZone">The Availability Zone where the VPN gateway was created</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.IsSetAvailabilityZone"> <summary> Checks if AvailabilityZone property is set </summary> <returns>true if AvailabilityZone property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.WithVpcAttachment(Amazon.EC2.Model.VpcAttachment[])"> <summary> Sets the list of VPC attachments. </summary> <param name="list">list of VPC attachments</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.IsSetVpcAttachment"> <summary> Checks if VpcAttachment property is set </summary> <returns>true if VpcAttachment property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.WithTag(Amazon.EC2.Model.Tag[])"> <summary> Sets a list of tags for the VpnGateway. </summary> <param name="list">A list of tags for the VpnGateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnGateway.IsSetTag"> <summary> Checks if Tag property is set </summary> <returns>true if Tag property is set</returns> </member> <member name="P:Amazon.EC2.Model.VpnGateway.VpnGatewayId"> <summary> The ID of the VPN gateway </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.VpnGatewayState"> <summary> The current state of the VPN gateway. Valid values: pending, available, deleting, deleted </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.Type"> <summary> The type of VPN connection the VPN gateway supports (ipsec.1) </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.AvailabilityZone"> <summary> The Availability Zone where the VPN gateway was created </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.VpcAttachment"> <summary> List of VPC attachments. </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.Tag"> <summary> A list of tags for the VpnGateway. </summary> </member> <member name="T:Amazon.EC2.Model.VpnStaticRoute"> <summary> Vpn Static Route </summary> </member> <member name="M:Amazon.EC2.Model.VpnStaticRoute.WithDestinationCIDRBlock(System.String)"> <summary> Sets the destination CIDR block. </summary> <param name="cidr">CIDR</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnStaticRoute.IsSetDestinationCIDRBlock"> <summary> Checks if the DestinationCIDRBlock property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnStaticRoute.WithSource(System.String)"> <summary> Sets the Source property. </summary> <param name="source">DOCS_TODO</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnStaticRoute.IsSetSource"> <summary> Checks if the Source property is set. </summary> <returns>True if the property is set</returns> </member> <member name="M:Amazon.EC2.Model.VpnStaticRoute.WithState(System.String)"> <summary> Sets the current state of the static route. </summary> <param name="state">Current State; Valid values: pending | available | deleting | deleted</param> <returns>This instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnStaticRoute.IsSetState"> <summary> Checks if the State property is set. </summary> <returns>True if the property is set</returns> </member> <member name="P:Amazon.EC2.Model.VpnStaticRoute.DestinationCIDRBlock"> <summary> The destination CIDR block. </summary> </member> <member name="P:Amazon.EC2.Model.VpnStaticRoute.Source"> <summary> DOCS_TODO </summary> </member> <member name="P:Amazon.EC2.Model.VpnStaticRoute.State"> <summary> Gets and sets the current state of the static route. Valid values: pending | available | deleting | deleted </summary> </member> <member name="T:Amazon.EC2.Model.VpnTunnelTelemetry"> <summary> VPN Tunnel Telemetry </summary> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.WithOutsideIpAddress(System.String)"> <summary> Sets the Internet-routable IP address of the virtual private gateway's outside interface. </summary> <param name="outsideIpAddress">The Internet-routable address of the virtual private gateway.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.IsSetOutsideIpAddress"> <summary> Checks whether the OutsideIpAddress property is set. </summary> <returns>True if the OutsideIpAddress property is set.</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.WithStatus(System.String)"> <summary> Sets the status of the VPN tunnel. </summary> <param name="status">The status of the VPN tunnel.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.IsSetStatus"> <summary> Checks whether the Status property of the VPN tunnel is set. </summary> <returns>True if the Status property is set.</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.WithLastStatusChange(System.String)"> <summary> Sets the date and time of the last change in status. </summary> <param name="lastStatusChange">The date and time of the last change in status.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.IsSetLastStatusChange"> <summary> Checks whether the LastStatusChange property is set. </summary> <returns>True if the LastStatusChange property is set.</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.WithStatusMessage(System.String)"> <summary> Sets the description of an error, if an error occurs. </summary> <param name="statusMessage">The description of the error.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.IsSetStatusMessage"> <summary> Checks whether the StatusMessage property is set. </summary> <returns>True if the StatusMessage property is set.</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.WithAcceptedRouteCount(System.Int32)"> <summary> Sets the number of accepted routes. </summary> <param name="acceptedRouteCount">The number of accepted routes.</param> <returns>this instance</returns> </member> <member name="M:Amazon.EC2.Model.VpnTunnelTelemetry.IsSetAcceptedRouteCount"> <summary> Checks whether the AcceptedRouteCount property is set. </summary> <returns>True if the AcceptedRouteCount property is set.</returns> </member> <member name="P:Amazon.EC2.Model.VpnTunnelTelemetry.OutsideIpAddress"> <summary> The Internet-routable IP address of the virtual private gateway's outside interface. </summary> </member> <member name="P:Amazon.EC2.Model.VpnTunnelTelemetry.Status"> <summary> The status of the VPN tunnel. </summary> </member> <member name="P:Amazon.EC2.Model.VpnTunnelTelemetry.LastStatusChange"> <summary> The date and time of the last change in status. </summary> </member> <member name="P:Amazon.EC2.Model.VpnTunnelTelemetry.StatusMessage"> <summary> Description of an error, if an error occurs. </summary> </member> <member name="P:Amazon.EC2.Model.VpnTunnelTelemetry.AcceptedRouteCount"> <summary> The number of accepted routes. </summary> </member> <member name="T:Amazon.EC2.Util.S3UploadPolicy"> <summary> This class represents S3 upload policy. Policy string representaion and signature to be used within EC2 bundling API. </summary> </member> <member name="M:Amazon.EC2.Util.S3UploadPolicy.#ctor(System.String,System.Security.SecureString,System.String,System.String,System.Int32)"> <summary> S3 Upload policy to be used by EC2 API. </summary> <param name="awsAccessKeyId">Access Key Id of the signer of the policy</param> <param name="awsSecretAccessKey">Secret Key of the signer of the policy</param> <param name="bucketName">Bucket name to upload</param> <param name="prefix">Prefix for the object keys</param> <param name="expireInMinutes">Expire, minutes from now</param> </member> <member name="M:Amazon.EC2.Util.S3UploadPolicy.#ctor(System.String,System.String,System.String,System.Int32)"> <summary> S3 Upload policy to be used by EC2 API. </summary> <param name="awsSecretAccessKey">Secret Key of the signer of the policy</param> <param name="bucketName">Bucket name to upload</param> <param name="prefix">Prefix for the object keys</param> <param name="expireInMinutes">Expire, minutes from now</param> </member> <member name="P:Amazon.EC2.Util.S3UploadPolicy.PolicyString"> <summary> Base64 representation of the serialized policy. Use policy generated by this method for passing to EC2 bunding calls. </summary> <returns>Base64 policy</returns> </member> <member name="P:Amazon.EC2.Util.S3UploadPolicy.PolicySignature"> <summary> Policy signature in base64 format Use signature generated by this method for passing to EC2 bunding calls along with policy. </summary> <returns>Base64 signature</returns> </member> <member name="T:Amazon.EC2.Util.VPCUtilities"> <summary> This class has utility methods used for setting up a VPC. </summary> </member> <member name="M:Amazon.EC2.Util.VPCUtilities.LaunchNATInstance(Amazon.EC2.AmazonEC2,Amazon.EC2.Util.LaunchNATInstanceRequest)"> <summary> This method will look up the current VPC NAT ami in the region and create an instance in the subnet specified. </summary> <param name="ec2Client">The ec2client used to create the NAT instance</param> <param name="request">The properties used to launch the NAT instance.</param> <returns></returns> </member> <member name="M:Amazon.EC2.Util.VPCUtilities.LaunchVPCWithPublicSubnet(Amazon.EC2.AmazonEC2,Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest)"> <summary> This method will create a VPC with a subnet that will have an internet gateway attached making instances available to the internet. </summary> <param name="ec2Client">The ec2client used to create the VPC</param> <param name="request">The properties used to create the VPC.</param> <returns>The response contains all the VPC objects that were created.</returns> </member> <member name="M:Amazon.EC2.Util.VPCUtilities.LaunchVPCWithPublicSubnet(Amazon.EC2.AmazonEC2,Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest,Amazon.EC2.Util.LaunchVPCWithPublicSubnetResponse)"> <summary> This method will create a VPC with a subnet that will have an internet gateway attached making instances available to the internet. </summary> <param name="ec2Client">The ec2client used to create the VPC</param> <param name="request">The properties used to create the VPC.</param> <param name="response">The response contains all the VPC objects that were created.</param> </member> <member name="M:Amazon.EC2.Util.VPCUtilities.LaunchVPCWithPublicAndPrivateSubnets(Amazon.EC2.AmazonEC2,Amazon.EC2.Util.LaunchVPCWithPublicAndPrivateSubnetsRequest)"> <summary> This method will create a VPC, a public subnet, private subnet and a NAT EC2 instance to allow EC2 instances in the private subnet to establish outbound connections to the internet. </summary> <param name="ec2Client">The ec2client used to create the VPC</param> <param name="request">The properties used to create the VPC.</param> <returns>The response contains all the VPC objects that were created.</returns> </member> <member name="T:Amazon.EC2.Util.VPCUtilities.Progress"> <summary> A callback delegate used to get progress messages as the VPC environment is being created. </summary> </member> <member name="T:Amazon.ElastiCache.AmazonElastiCache"> <summary> Interface for accessing AmazonElastiCache. 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 set-up, 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.AmazonElastiCache.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"> <summary> <para>The <i>ModifyCacheParameterGroup</i> operation 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.</para> </summary> <param name="modifyCacheParameterGroupRequest">Container for the necessary parameters to execute the ModifyCacheParameterGroup service method on AmazonElastiCache.</param> <returns>The response from the ModifyCacheParameterGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"/> </summary> <param name="modifyCacheParameterGroupRequest">Container for the necessary parameters to execute the ModifyCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyCacheParameterGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndModifyCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyCacheParameterGroup.</param> <returns>Returns a ModifyCacheParameterGroupResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"> <summary> <para>The <i>ResetCacheParameterGroup</i> operation 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.</para> </summary> <param name="resetCacheParameterGroupRequest">Container for the necessary parameters to execute the ResetCacheParameterGroup service method on AmazonElastiCache.</param> <returns>The response from the ResetCacheParameterGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"/> </summary> <param name="resetCacheParameterGroupRequest">Container for the necessary parameters to execute the ResetCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetCacheParameterGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndResetCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetCacheParameterGroup.</param> <returns>Returns a ResetCacheParameterGroupResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"> <summary> <para>The <i>CopySnapshot</i> operation makes a copy of an existing snapshot.</para> </summary> <param name="copySnapshotRequest">Container for the necessary parameters to execute the CopySnapshot service method on AmazonElastiCache.</param> <returns>The response from the CopySnapshot service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginCopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"/> </summary> <param name="copySnapshotRequest">Container for the necessary parameters to execute the CopySnapshot operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopySnapshot operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndCopySnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CopySnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCopySnapshot.</param> <returns>Returns a Snapshot from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"> <summary> <para>The <i>DescribeCacheSecurityGroups</i> operation 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.</para> </summary> <param name="describeCacheSecurityGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSecurityGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheSecurityGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"/> </summary> <param name="describeCacheSecurityGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSecurityGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheSecurityGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeCacheSecurityGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheSecurityGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheSecurityGroups.</param> <returns>Returns a DescribeCacheSecurityGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSecurityGroups"> <summary> <para>The <i>DescribeCacheSecurityGroups</i> operation 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.</para> </summary> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"> <summary> <para>The <i>CreateCacheSubnetGroup</i> operation creates a new cache subnet group.</para> <para>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).</para> </summary> <param name="createCacheSubnetGroupRequest">Container for the necessary parameters to execute the CreateCacheSubnetGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheSubnetGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginCreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"/> </summary> <param name="createCacheSubnetGroupRequest">Container for the necessary parameters to execute the CreateCacheSubnetGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheSubnetGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndCreateCacheSubnetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheSubnetGroup.</param> <returns>Returns a CacheSubnetGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"> <summary> <para>The <i>AuthorizeCacheSecurityGroupIngress</i> operation 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.</para> <para><b>NOTE:</b> You cannot authorize ingress from an Amazon EC2 security group in one Region to an ElastiCache cluster in another Region. </para> </summary> <param name="authorizeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress service method on AmazonElastiCache.</param> <returns>The response from the AuthorizeCacheSecurityGroupIngress service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginAuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"/> </summary> <param name="authorizeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAuthorizeCacheSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndAuthorizeCacheSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAuthorizeCacheSecurityGroupIngress.</param> <returns>Returns a CacheSecurityGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"> <summary> <para>The <i>DeleteCacheSecurityGroup</i> operation deletes a cache security group.</para> <para><b>NOTE:</b>You cannot delete a cache security group if it is associated with any cache clusters.</para> </summary> <param name="deleteCacheSecurityGroupRequest">Container for the necessary parameters to execute the DeleteCacheSecurityGroup service method on AmazonElastiCache.</param> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"/> </summary> <param name="deleteCacheSecurityGroupRequest">Container for the necessary parameters to execute the DeleteCacheSecurityGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDeleteCacheSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheSecurityGroup.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"> <summary> <para>The <i>DescribeEngineDefaultParameters</i> operation returns the default engine and system parameter information for the specified cache engine.</para> </summary> <param name="describeEngineDefaultParametersRequest">Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method on AmazonElastiCache.</param> <returns>The response from the DescribeEngineDefaultParameters service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"/> </summary> <param name="describeEngineDefaultParametersRequest">Container for the necessary parameters to execute the DescribeEngineDefaultParameters operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEngineDefaultParameters operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeEngineDefaultParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEngineDefaultParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEngineDefaultParameters.</param> <returns>Returns a EngineDefaults from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"> <summary> <para>The <i>ModifyCacheSubnetGroup</i> operation modifies an existing cache subnet group.</para> </summary> <param name="modifyCacheSubnetGroupRequest">Container for the necessary parameters to execute the ModifyCacheSubnetGroup service method on AmazonElastiCache.</param> <returns>The response from the ModifyCacheSubnetGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"/> <exception cref="T:Amazon.ElastiCache.Model.SubnetInUseException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"/> </summary> <param name="modifyCacheSubnetGroupRequest">Container for the necessary parameters to execute the ModifyCacheSubnetGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyCacheSubnetGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndModifyCacheSubnetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyCacheSubnetGroup.</param> <returns>Returns a CacheSubnetGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"> <summary> <para>The <i>RevokeCacheSecurityGroupIngress</i> operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.</para> </summary> <param name="revokeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress service method on AmazonElastiCache.</param> <returns>The response from the RevokeCacheSecurityGroupIngress service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginRevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RevokeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"/> </summary> <param name="revokeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRevokeCacheSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndRevokeCacheSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RevokeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeCacheSecurityGroupIngress.</param> <returns>Returns a CacheSecurityGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"> <summary> <para>The <i>ModifyReplicationGroup</i> operation modifies the settings for a replication group.</para> </summary> <param name="modifyReplicationGroupRequest">Container for the necessary parameters to execute the ModifyReplicationGroup service method on AmazonElastiCache.</param> <returns>The response from the ModifyReplicationGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"/> </summary> <param name="modifyReplicationGroupRequest">Container for the necessary parameters to execute the ModifyReplicationGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyReplicationGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndModifyReplicationGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyReplicationGroup.</param> <returns>Returns a ReplicationGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"> <summary> <para>The <i>CreateCacheParameterGroup</i> operation 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.</para> </summary> <param name="createCacheParameterGroupRequest">Container for the necessary parameters to execute the CreateCacheParameterGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheParameterGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginCreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"/> </summary> <param name="createCacheParameterGroupRequest">Container for the necessary parameters to execute the CreateCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheParameterGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndCreateCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheParameterGroup.</param> <returns>Returns a CacheParameterGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"> <summary> <para>The <i>DeleteReplicationGroup</i> operation deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary cache cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cache cluster.</para> <para>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.</para> </summary> <param name="deleteReplicationGroupRequest">Container for the necessary parameters to execute the DeleteReplicationGroup service method on AmazonElastiCache.</param> <returns>The response from the DeleteReplicationGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"/> </summary> <param name="deleteReplicationGroupRequest">Container for the necessary parameters to execute the DeleteReplicationGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteReplicationGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDeleteReplicationGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteReplicationGroup.</param> <returns>Returns a ReplicationGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"> <summary> <para>The <i>DeleteSnapshot</i> operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.</para> </summary> <param name="deleteSnapshotRequest">Container for the necessary parameters to execute the DeleteSnapshot service method on AmazonElastiCache.</param> <returns>The response from the DeleteSnapshot service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"/> </summary> <param name="deleteSnapshotRequest">Container for the necessary parameters to execute the DeleteSnapshot operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSnapshot operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDeleteSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSnapshot.</param> <returns>Returns a Snapshot from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"> <summary> <para>The <i>DescribeCacheParameters</i> operation returns the detailed parameter list for a particular cache parameter group.</para> </summary> <param name="describeCacheParametersRequest">Container for the necessary parameters to execute the DescribeCacheParameters service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheParameters service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"/> </summary> <param name="describeCacheParametersRequest">Container for the necessary parameters to execute the DescribeCacheParameters operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheParameters operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeCacheParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheParameters.</param> <returns>Returns a DescribeCacheParametersResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"> <summary> <para>The <i>DescribeCacheSubnetGroups</i> operation 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.</para> </summary> <param name="describeCacheSubnetGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSubnetGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheSubnetGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"/> </summary> <param name="describeCacheSubnetGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSubnetGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheSubnetGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeCacheSubnetGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheSubnetGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheSubnetGroups.</param> <returns>Returns a DescribeCacheSubnetGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSubnetGroups"> <summary> <para>The <i>DescribeCacheSubnetGroups</i> operation 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.</para> </summary> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"> <summary> <para>The <i>DescribeReplicationGroups</i> operation returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups.</para> </summary> <param name="describeReplicationGroupsRequest">Container for the necessary parameters to execute the DescribeReplicationGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeReplicationGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReplicationGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"/> </summary> <param name="describeReplicationGroupsRequest">Container for the necessary parameters to execute the DescribeReplicationGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReplicationGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeReplicationGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReplicationGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReplicationGroups.</param> <returns>Returns a DescribeReplicationGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReplicationGroups"> <summary> <para>The <i>DescribeReplicationGroups</i> operation returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups.</para> </summary> <returns>The response from the DescribeReplicationGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"> <summary> <para>The <i>DescribeReservedCacheNodesOfferings</i> operation lists available reserved cache node offerings.</para> </summary> <param name="describeReservedCacheNodesOfferingsRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings service method on AmazonElastiCache.</param> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodesOfferings operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"/> </summary> <param name="describeReservedCacheNodesOfferingsRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedCacheNodesOfferings operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeReservedCacheNodesOfferings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedCacheNodesOfferings operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedCacheNodesOfferings.</param> <returns>Returns a DescribeReservedCacheNodesOfferingsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodesOfferings"> <summary> <para>The <i>DescribeReservedCacheNodesOfferings</i> operation lists available reserved cache node offerings.</para> </summary> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"> <summary> <para>The <i>DescribeCacheParameterGroups</i> operation 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.</para> </summary> <param name="describeCacheParameterGroupsRequest">Container for the necessary parameters to execute the DescribeCacheParameterGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheParameterGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameterGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"/> </summary> <param name="describeCacheParameterGroupsRequest">Container for the necessary parameters to execute the DescribeCacheParameterGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheParameterGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeCacheParameterGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheParameterGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheParameterGroups.</param> <returns>Returns a DescribeCacheParameterGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameterGroups"> <summary> <para>The <i>DescribeCacheParameterGroups</i> operation 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.</para> </summary> <returns>The response from the DescribeCacheParameterGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"> <summary> <para>The <i>DescribeReservedCacheNodes</i> operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.</para> </summary> <param name="describeReservedCacheNodesRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodes service method on AmazonElastiCache.</param> <returns>The response from the DescribeReservedCacheNodes service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodes operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"/> </summary> <param name="describeReservedCacheNodesRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodes operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedCacheNodes operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeReservedCacheNodes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedCacheNodes operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedCacheNodes.</param> <returns>Returns a DescribeReservedCacheNodesResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodes"> <summary> <para>The <i>DescribeReservedCacheNodes</i> operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.</para> </summary> <returns>The response from the DescribeReservedCacheNodes service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"> <summary> <para>The <i>DeleteCacheCluster</i> operation 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 operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.</para> </summary> <param name="deleteCacheClusterRequest">Container for the necessary parameters to execute the DeleteCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the DeleteCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"/> </summary> <param name="deleteCacheClusterRequest">Container for the necessary parameters to execute the DeleteCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDeleteCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"> <summary> <para>The <i>DescribeSnapshots</i> operation 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.</para> </summary> <param name="describeSnapshotsRequest">Container for the necessary parameters to execute the DescribeSnapshots service method on AmazonElastiCache.</param> <returns>The response from the DescribeSnapshots service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"/> </summary> <param name="describeSnapshotsRequest">Container for the necessary parameters to execute the DescribeSnapshots operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSnapshots operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeSnapshots(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshots operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshots.</param> <returns>Returns a DescribeSnapshotsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeSnapshots"> <summary> <para>The <i>DescribeSnapshots</i> operation 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.</para> </summary> <returns>The response from the DescribeSnapshots service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"> <summary> <para>The <i>CreateSnapshot</i> operation creates a copy of an entire cache cluster at a specific moment in time.</para> </summary> <param name="createSnapshotRequest">Container for the necessary parameters to execute the CreateSnapshot service method on AmazonElastiCache.</param> <returns>The response from the CreateSnapshot service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginCreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"/> </summary> <param name="createSnapshotRequest">Container for the necessary parameters to execute the CreateSnapshot operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSnapshot operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndCreateSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSnapshot.</param> <returns>Returns a Snapshot from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"> <summary> <para>The <i>DescribeCacheEngineVersions</i> operation returns a list of the available cache engines and their versions.</para> </summary> <param name="describeCacheEngineVersionsRequest">Container for the necessary parameters to execute the DescribeCacheEngineVersions service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheEngineVersions service method, as returned by AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheEngineVersions operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"/> </summary> <param name="describeCacheEngineVersionsRequest">Container for the necessary parameters to execute the DescribeCacheEngineVersions operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheEngineVersions operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeCacheEngineVersions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheEngineVersions operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheEngineVersions.</param> <returns>Returns a DescribeCacheEngineVersionsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheEngineVersions"> <summary> <para>The <i>DescribeCacheEngineVersions</i> operation returns a list of the available cache engines and their versions.</para> </summary> <returns>The response from the DescribeCacheEngineVersions service method, as returned by AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"> <summary> <para>The <i>DeleteCacheParameterGroup</i> operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.</para> </summary> <param name="deleteCacheParameterGroupRequest">Container for the necessary parameters to execute the DeleteCacheParameterGroup service method on AmazonElastiCache.</param> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"/> </summary> <param name="deleteCacheParameterGroupRequest">Container for the necessary parameters to execute the DeleteCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDeleteCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheParameterGroup.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"> <summary> <para>The <i>ModifyCacheCluster</i> operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.</para> </summary> <param name="modifyCacheClusterRequest">Container for the necessary parameters to execute the ModifyCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the ModifyCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"/> </summary> <param name="modifyCacheClusterRequest">Container for the necessary parameters to execute the ModifyCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndModifyCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"> <summary> <para>The <i>DeleteCacheSubnetGroup</i> operation deletes a cache subnet group.</para> <para><b>NOTE:</b>You cannot delete a cache subnet group if it is associated with any cache clusters.</para> </summary> <param name="deleteCacheSubnetGroupRequest">Container for the necessary parameters to execute the DeleteCacheSubnetGroup service method on AmazonElastiCache.</param> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupInUseException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"/> </summary> <param name="deleteCacheSubnetGroupRequest">Container for the necessary parameters to execute the DeleteCacheSubnetGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDeleteCacheSubnetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheSubnetGroup.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"> <summary> <para>The <i>RebootCacheCluster</i> operation reboots some, or all, of the cache cluster 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> <para>The reboot causes the contents of the cache (for each cache cluster node being rebooted) to be lost.</para> <para>When the reboot is complete, a cache cluster event is created.</para> </summary> <param name="rebootCacheClusterRequest">Container for the necessary parameters to execute the RebootCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the RebootCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginRebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RebootCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"/> </summary> <param name="rebootCacheClusterRequest">Container for the necessary parameters to execute the RebootCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRebootCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndRebootCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RebootCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRebootCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"> <summary> <para>The <i>CreateCacheCluster</i> operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.</para> </summary> <param name="createCacheClusterRequest">Container for the necessary parameters to execute the CreateCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginCreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"/> </summary> <param name="createCacheClusterRequest">Container for the necessary parameters to execute the CreateCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndCreateCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"> <summary> <para>The <i>CreateCacheSecurityGroup</i> operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.</para> <para>Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see <i>CreateCacheSubnetGroup</i> .</para> </summary> <param name="createCacheSecurityGroupRequest">Container for the necessary parameters to execute the CreateCacheSecurityGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheSecurityGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginCreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"/> </summary> <param name="createCacheSecurityGroupRequest">Container for the necessary parameters to execute the CreateCacheSecurityGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheSecurityGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndCreateCacheSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheSecurityGroup.</param> <returns>Returns a CacheSecurityGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"> <summary> <para>The <i>DescribeCacheClusters</i> operation 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> <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="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheClusters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"/> </summary> <param name="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheClusters operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeCacheClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheClusters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheClusters.</param> <returns>Returns a DescribeCacheClustersResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheClusters"> <summary> <para>The <i>DescribeCacheClusters</i> operation 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> <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 AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"> <summary> <para>The <i>PurchaseReservedCacheNodesOffering</i> operation allows you to purchase a reserved cache node offering.</para> </summary> <param name="purchaseReservedCacheNodesOfferingRequest">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering service method on AmazonElastiCache.</param> <returns>The response from the PurchaseReservedCacheNodesOffering service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginPurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PurchaseReservedCacheNodesOffering operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"/> </summary> <param name="purchaseReservedCacheNodesOfferingRequest">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPurchaseReservedCacheNodesOffering operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndPurchaseReservedCacheNodesOffering(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PurchaseReservedCacheNodesOffering operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPurchaseReservedCacheNodesOffering.</param> <returns>Returns a ReservedCacheNode from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"> <summary> <para>The <i>CreateReplicationGroup</i> operation creates a replication group. A replication group is a collection of cache clusters, where one of the clusters is a read/write primary and the other clusters are read-only replicas. Writes to the primary are automatically propagated to the replicas.</para> <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> </summary> <param name="createReplicationGroupRequest">Container for the necessary parameters to execute the CreateReplicationGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateReplicationGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginCreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"/> </summary> <param name="createReplicationGroupRequest">Container for the necessary parameters to execute the CreateReplicationGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateReplicationGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndCreateReplicationGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateReplicationGroup.</param> <returns>Returns a ReplicationGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"> <summary> <para>The <i>DescribeEvents</i> operation 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> <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="describeEventsRequest">Container for the necessary parameters to execute the DescribeEvents service method on AmazonElastiCache.</param> <returns>The response from the DescribeEvents service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.BeginDescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"/> </summary> <param name="describeEventsRequest">Container for the necessary parameters to execute the DescribeEvents operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEvents operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.EndDescribeEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEvents operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEvents.</param> <returns>Returns a DescribeEventsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEvents"> <summary> <para>The <i>DescribeEvents</i> operation 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> <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 AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="T:Amazon.ElastiCache.AmazonElastiCacheClient"> <summary> Implementation for accessing AmazonElastiCache. 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 set-up, 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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElastiCache 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"> <summary> <para>The <i>ModifyCacheParameterGroup</i> operation 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.</para> </summary> <param name="modifyCacheParameterGroupRequest">Container for the necessary parameters to execute the ModifyCacheParameterGroup service method on AmazonElastiCache.</param> <returns>The response from the ModifyCacheParameterGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"/> </summary> <param name="modifyCacheParameterGroupRequest">Container for the necessary parameters to execute the ModifyCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyCacheParameterGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndModifyCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyCacheParameterGroup.</param> <returns>Returns a ModifyCacheParameterGroupResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"> <summary> <para>The <i>ResetCacheParameterGroup</i> operation 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.</para> </summary> <param name="resetCacheParameterGroupRequest">Container for the necessary parameters to execute the ResetCacheParameterGroup service method on AmazonElastiCache.</param> <returns>The response from the ResetCacheParameterGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"/> </summary> <param name="resetCacheParameterGroupRequest">Container for the necessary parameters to execute the ResetCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetCacheParameterGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndResetCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetCacheParameterGroup.</param> <returns>Returns a ResetCacheParameterGroupResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"> <summary> <para>The <i>CopySnapshot</i> operation makes a copy of an existing snapshot.</para> </summary> <param name="copySnapshotRequest">Container for the necessary parameters to execute the CopySnapshot service method on AmazonElastiCache.</param> <returns>The response from the CopySnapshot service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginCopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"/> </summary> <param name="copySnapshotRequest">Container for the necessary parameters to execute the CopySnapshot operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopySnapshot operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndCopySnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CopySnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCopySnapshot.</param> <returns>Returns a Snapshot from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"> <summary> <para>The <i>DescribeCacheSecurityGroups</i> operation 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.</para> </summary> <param name="describeCacheSecurityGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSecurityGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheSecurityGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"/> </summary> <param name="describeCacheSecurityGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSecurityGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheSecurityGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeCacheSecurityGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheSecurityGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheSecurityGroups.</param> <returns>Returns a DescribeCacheSecurityGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSecurityGroups"> <summary> <para>The <i>DescribeCacheSecurityGroups</i> operation 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.</para> </summary> <returns>The response from the DescribeCacheSecurityGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"> <summary> <para>The <i>CreateCacheSubnetGroup</i> operation creates a new cache subnet group.</para> <para>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).</para> </summary> <param name="createCacheSubnetGroupRequest">Container for the necessary parameters to execute the CreateCacheSubnetGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheSubnetGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginCreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"/> </summary> <param name="createCacheSubnetGroupRequest">Container for the necessary parameters to execute the CreateCacheSubnetGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheSubnetGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndCreateCacheSubnetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheSubnetGroup.</param> <returns>Returns a CacheSubnetGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"> <summary> <para>The <i>AuthorizeCacheSecurityGroupIngress</i> operation 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.</para> <para><b>NOTE:</b> You cannot authorize ingress from an Amazon EC2 security group in one Region to an ElastiCache cluster in another Region. </para> </summary> <param name="authorizeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress service method on AmazonElastiCache.</param> <returns>The response from the AuthorizeCacheSecurityGroupIngress service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginAuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"/> </summary> <param name="authorizeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the AuthorizeCacheSecurityGroupIngress operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAuthorizeCacheSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndAuthorizeCacheSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AuthorizeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAuthorizeCacheSecurityGroupIngress.</param> <returns>Returns a CacheSecurityGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"> <summary> <para>The <i>DeleteCacheSecurityGroup</i> operation deletes a cache security group.</para> <para><b>NOTE:</b>You cannot delete a cache security group if it is associated with any cache clusters.</para> </summary> <param name="deleteCacheSecurityGroupRequest">Container for the necessary parameters to execute the DeleteCacheSecurityGroup service method on AmazonElastiCache.</param> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"/> </summary> <param name="deleteCacheSecurityGroupRequest">Container for the necessary parameters to execute the DeleteCacheSecurityGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDeleteCacheSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheSecurityGroup.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"> <summary> <para>The <i>DescribeEngineDefaultParameters</i> operation returns the default engine and system parameter information for the specified cache engine.</para> </summary> <param name="describeEngineDefaultParametersRequest">Container for the necessary parameters to execute the DescribeEngineDefaultParameters service method on AmazonElastiCache.</param> <returns>The response from the DescribeEngineDefaultParameters service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"/> </summary> <param name="describeEngineDefaultParametersRequest">Container for the necessary parameters to execute the DescribeEngineDefaultParameters operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEngineDefaultParameters operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeEngineDefaultParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEngineDefaultParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEngineDefaultParameters.</param> <returns>Returns a EngineDefaults from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"> <summary> <para>The <i>ModifyCacheSubnetGroup</i> operation modifies an existing cache subnet group.</para> </summary> <param name="modifyCacheSubnetGroupRequest">Container for the necessary parameters to execute the ModifyCacheSubnetGroup service method on AmazonElastiCache.</param> <returns>The response from the ModifyCacheSubnetGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidSubnetException"/> <exception cref="T:Amazon.ElastiCache.Model.SubnetInUseException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"/> </summary> <param name="modifyCacheSubnetGroupRequest">Container for the necessary parameters to execute the ModifyCacheSubnetGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyCacheSubnetGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndModifyCacheSubnetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyCacheSubnetGroup.</param> <returns>Returns a CacheSubnetGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"> <summary> <para>The <i>RevokeCacheSecurityGroupIngress</i> operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.</para> </summary> <param name="revokeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress service method on AmazonElastiCache.</param> <returns>The response from the RevokeCacheSecurityGroupIngress service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.AuthorizationNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginRevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RevokeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"/> </summary> <param name="revokeCacheSecurityGroupIngressRequest">Container for the necessary parameters to execute the RevokeCacheSecurityGroupIngress operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRevokeCacheSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndRevokeCacheSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RevokeCacheSecurityGroupIngress operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeCacheSecurityGroupIngress.</param> <returns>Returns a CacheSecurityGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"> <summary> <para>The <i>ModifyReplicationGroup</i> operation modifies the settings for a replication group.</para> </summary> <param name="modifyReplicationGroupRequest">Container for the necessary parameters to execute the ModifyReplicationGroup service method on AmazonElastiCache.</param> <returns>The response from the ModifyReplicationGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"/> </summary> <param name="modifyReplicationGroupRequest">Container for the necessary parameters to execute the ModifyReplicationGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyReplicationGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndModifyReplicationGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyReplicationGroup.</param> <returns>Returns a ReplicationGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"> <summary> <para>The <i>CreateCacheParameterGroup</i> operation 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.</para> </summary> <param name="createCacheParameterGroupRequest">Container for the necessary parameters to execute the CreateCacheParameterGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheParameterGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginCreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"/> </summary> <param name="createCacheParameterGroupRequest">Container for the necessary parameters to execute the CreateCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheParameterGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndCreateCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheParameterGroup.</param> <returns>Returns a CacheParameterGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"> <summary> <para>The <i>DeleteReplicationGroup</i> operation deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary cache cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cache cluster.</para> <para>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.</para> </summary> <param name="deleteReplicationGroupRequest">Container for the necessary parameters to execute the DeleteReplicationGroup service method on AmazonElastiCache.</param> <returns>The response from the DeleteReplicationGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"/> </summary> <param name="deleteReplicationGroupRequest">Container for the necessary parameters to execute the DeleteReplicationGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteReplicationGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDeleteReplicationGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteReplicationGroup.</param> <returns>Returns a ReplicationGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"> <summary> <para>The <i>DeleteSnapshot</i> operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.</para> </summary> <param name="deleteSnapshotRequest">Container for the necessary parameters to execute the DeleteSnapshot service method on AmazonElastiCache.</param> <returns>The response from the DeleteSnapshot service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"/> </summary> <param name="deleteSnapshotRequest">Container for the necessary parameters to execute the DeleteSnapshot operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSnapshot operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDeleteSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSnapshot.</param> <returns>Returns a Snapshot from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"> <summary> <para>The <i>DescribeCacheParameters</i> operation returns the detailed parameter list for a particular cache parameter group.</para> </summary> <param name="describeCacheParametersRequest">Container for the necessary parameters to execute the DescribeCacheParameters service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheParameters service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"/> </summary> <param name="describeCacheParametersRequest">Container for the necessary parameters to execute the DescribeCacheParameters operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheParameters operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeCacheParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheParameters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheParameters.</param> <returns>Returns a DescribeCacheParametersResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"> <summary> <para>The <i>DescribeCacheSubnetGroups</i> operation 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.</para> </summary> <param name="describeCacheSubnetGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSubnetGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheSubnetGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"/> </summary> <param name="describeCacheSubnetGroupsRequest">Container for the necessary parameters to execute the DescribeCacheSubnetGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheSubnetGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeCacheSubnetGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheSubnetGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheSubnetGroups.</param> <returns>Returns a DescribeCacheSubnetGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheSubnetGroups"> <summary> <para>The <i>DescribeCacheSubnetGroups</i> operation 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.</para> </summary> <returns>The response from the DescribeCacheSubnetGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"> <summary> <para>The <i>DescribeReplicationGroups</i> operation returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups.</para> </summary> <param name="describeReplicationGroupsRequest">Container for the necessary parameters to execute the DescribeReplicationGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeReplicationGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReplicationGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"/> </summary> <param name="describeReplicationGroupsRequest">Container for the necessary parameters to execute the DescribeReplicationGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReplicationGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeReplicationGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReplicationGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReplicationGroups.</param> <returns>Returns a DescribeReplicationGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReplicationGroups"> <summary> <para>The <i>DescribeReplicationGroups</i> operation returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups.</para> </summary> <returns>The response from the DescribeReplicationGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"> <summary> <para>The <i>DescribeReservedCacheNodesOfferings</i> operation lists available reserved cache node offerings.</para> </summary> <param name="describeReservedCacheNodesOfferingsRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings service method on AmazonElastiCache.</param> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodesOfferings operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"/> </summary> <param name="describeReservedCacheNodesOfferingsRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodesOfferings operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedCacheNodesOfferings operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeReservedCacheNodesOfferings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedCacheNodesOfferings operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedCacheNodesOfferings.</param> <returns>Returns a DescribeReservedCacheNodesOfferingsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodesOfferings"> <summary> <para>The <i>DescribeReservedCacheNodesOfferings</i> operation lists available reserved cache node offerings.</para> </summary> <returns>The response from the DescribeReservedCacheNodesOfferings service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"> <summary> <para>The <i>DescribeCacheParameterGroups</i> operation 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.</para> </summary> <param name="describeCacheParameterGroupsRequest">Container for the necessary parameters to execute the DescribeCacheParameterGroups service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheParameterGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheParameterGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"/> </summary> <param name="describeCacheParameterGroupsRequest">Container for the necessary parameters to execute the DescribeCacheParameterGroups operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheParameterGroups operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeCacheParameterGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheParameterGroups operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheParameterGroups.</param> <returns>Returns a DescribeCacheParameterGroupsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheParameterGroups"> <summary> <para>The <i>DescribeCacheParameterGroups</i> operation 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.</para> </summary> <returns>The response from the DescribeCacheParameterGroups service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"> <summary> <para>The <i>DescribeReservedCacheNodes</i> operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.</para> </summary> <param name="describeReservedCacheNodesRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodes service method on AmazonElastiCache.</param> <returns>The response from the DescribeReservedCacheNodes service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedCacheNodes operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"/> </summary> <param name="describeReservedCacheNodesRequest">Container for the necessary parameters to execute the DescribeReservedCacheNodes operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedCacheNodes operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeReservedCacheNodes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedCacheNodes operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedCacheNodes.</param> <returns>Returns a DescribeReservedCacheNodesResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeReservedCacheNodes"> <summary> <para>The <i>DescribeReservedCacheNodes</i> operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.</para> </summary> <returns>The response from the DescribeReservedCacheNodes service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"> <summary> <para>The <i>DeleteCacheCluster</i> operation 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 operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.</para> </summary> <param name="deleteCacheClusterRequest">Container for the necessary parameters to execute the DeleteCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the DeleteCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"/> </summary> <param name="deleteCacheClusterRequest">Container for the necessary parameters to execute the DeleteCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDeleteCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"> <summary> <para>The <i>DescribeSnapshots</i> operation 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.</para> </summary> <param name="describeSnapshotsRequest">Container for the necessary parameters to execute the DescribeSnapshots service method on AmazonElastiCache.</param> <returns>The response from the DescribeSnapshots service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"/> </summary> <param name="describeSnapshotsRequest">Container for the necessary parameters to execute the DescribeSnapshots operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSnapshots operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeSnapshots(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshots operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshots.</param> <returns>Returns a DescribeSnapshotsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeSnapshots"> <summary> <para>The <i>DescribeSnapshots</i> operation 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.</para> </summary> <returns>The response from the DescribeSnapshots service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"> <summary> <para>The <i>CreateSnapshot</i> operation creates a copy of an entire cache cluster at a specific moment in time.</para> </summary> <param name="createSnapshotRequest">Container for the necessary parameters to execute the CreateSnapshot service method on AmazonElastiCache.</param> <returns>The response from the CreateSnapshot service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginCreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"/> </summary> <param name="createSnapshotRequest">Container for the necessary parameters to execute the CreateSnapshot operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSnapshot operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndCreateSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSnapshot operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSnapshot.</param> <returns>Returns a Snapshot from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"> <summary> <para>The <i>DescribeCacheEngineVersions</i> operation returns a list of the available cache engines and their versions.</para> </summary> <param name="describeCacheEngineVersionsRequest">Container for the necessary parameters to execute the DescribeCacheEngineVersions service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheEngineVersions service method, as returned by AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheEngineVersions operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"/> </summary> <param name="describeCacheEngineVersionsRequest">Container for the necessary parameters to execute the DescribeCacheEngineVersions operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheEngineVersions operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeCacheEngineVersions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheEngineVersions operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheEngineVersions.</param> <returns>Returns a DescribeCacheEngineVersionsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheEngineVersions"> <summary> <para>The <i>DescribeCacheEngineVersions</i> operation returns a list of the available cache engines and their versions.</para> </summary> <returns>The response from the DescribeCacheEngineVersions service method, as returned by AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"> <summary> <para>The <i>DeleteCacheParameterGroup</i> operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.</para> </summary> <param name="deleteCacheParameterGroupRequest">Container for the necessary parameters to execute the DeleteCacheParameterGroup service method on AmazonElastiCache.</param> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"/> </summary> <param name="deleteCacheParameterGroupRequest">Container for the necessary parameters to execute the DeleteCacheParameterGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDeleteCacheParameterGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheParameterGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheParameterGroup.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"> <summary> <para>The <i>ModifyCacheCluster</i> operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.</para> </summary> <param name="modifyCacheClusterRequest">Container for the necessary parameters to execute the ModifyCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the ModifyCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"/> </summary> <param name="modifyCacheClusterRequest">Container for the necessary parameters to execute the ModifyCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndModifyCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"> <summary> <para>The <i>DeleteCacheSubnetGroup</i> operation deletes a cache subnet group.</para> <para><b>NOTE:</b>You cannot delete a cache subnet group if it is associated with any cache clusters.</para> </summary> <param name="deleteCacheSubnetGroupRequest">Container for the necessary parameters to execute the DeleteCacheSubnetGroup service method on AmazonElastiCache.</param> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupInUseException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"/> </summary> <param name="deleteCacheSubnetGroupRequest">Container for the necessary parameters to execute the DeleteCacheSubnetGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDeleteCacheSubnetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCacheSubnetGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCacheSubnetGroup.</param> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"> <summary> <para>The <i>RebootCacheCluster</i> operation reboots some, or all, of the cache cluster 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> <para>The reboot causes the contents of the cache (for each cache cluster node being rebooted) to be lost.</para> <para>When the reboot is complete, a cache cluster event is created.</para> </summary> <param name="rebootCacheClusterRequest">Container for the necessary parameters to execute the RebootCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the RebootCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginRebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RebootCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"/> </summary> <param name="rebootCacheClusterRequest">Container for the necessary parameters to execute the RebootCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRebootCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndRebootCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RebootCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRebootCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"> <summary> <para>The <i>CreateCacheCluster</i> operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.</para> </summary> <param name="createCacheClusterRequest">Container for the necessary parameters to execute the CreateCacheCluster service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheCluster service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"/> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginCreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"/> </summary> <param name="createCacheClusterRequest">Container for the necessary parameters to execute the CreateCacheCluster operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheCluster operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndCreateCacheCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheCluster operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheCluster.</param> <returns>Returns a CacheCluster from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"> <summary> <para>The <i>CreateCacheSecurityGroup</i> operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.</para> <para>Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see <i>CreateCacheSubnetGroup</i> .</para> </summary> <param name="createCacheSecurityGroupRequest">Container for the necessary parameters to execute the CreateCacheSecurityGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateCacheSecurityGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheSecurityGroupQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginCreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"/> </summary> <param name="createCacheSecurityGroupRequest">Container for the necessary parameters to execute the CreateCacheSecurityGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCacheSecurityGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndCreateCacheSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCacheSecurityGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCacheSecurityGroup.</param> <returns>Returns a CacheSecurityGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"> <summary> <para>The <i>DescribeCacheClusters</i> operation 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> <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="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters service method on AmazonElastiCache.</param> <returns>The response from the DescribeCacheClusters service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCacheClusters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"/> </summary> <param name="describeCacheClustersRequest">Container for the necessary parameters to execute the DescribeCacheClusters operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCacheClusters operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeCacheClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCacheClusters operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCacheClusters.</param> <returns>Returns a DescribeCacheClustersResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeCacheClusters"> <summary> <para>The <i>DescribeCacheClusters</i> operation 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> <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 AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"> <summary> <para>The <i>PurchaseReservedCacheNodesOffering</i> operation allows you to purchase a reserved cache node offering.</para> </summary> <param name="purchaseReservedCacheNodesOfferingRequest">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering service method on AmazonElastiCache.</param> <returns>The response from the PurchaseReservedCacheNodesOffering service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeQuotaExceededException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodeAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginPurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PurchaseReservedCacheNodesOffering operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"/> </summary> <param name="purchaseReservedCacheNodesOfferingRequest">Container for the necessary parameters to execute the PurchaseReservedCacheNodesOffering operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPurchaseReservedCacheNodesOffering operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndPurchaseReservedCacheNodesOffering(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PurchaseReservedCacheNodesOffering operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPurchaseReservedCacheNodesOffering.</param> <returns>Returns a ReservedCacheNode from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"> <summary> <para>The <i>CreateReplicationGroup</i> operation creates a replication group. A replication group is a collection of cache clusters, where one of the clusters is a read/write primary and the other clusters are read-only replicas. Writes to the primary are automatically propagated to the replicas.</para> <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> </summary> <param name="createReplicationGroupRequest">Container for the necessary parameters to execute the CreateReplicationGroup service method on AmazonElastiCache.</param> <returns>The response from the CreateReplicationGroup service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.ReplicationGroupAlreadyExistsException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginCreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"/> </summary> <param name="createReplicationGroupRequest">Container for the necessary parameters to execute the CreateReplicationGroup operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateReplicationGroup operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndCreateReplicationGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateReplicationGroup operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateReplicationGroup.</param> <returns>Returns a ReplicationGroup from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"> <summary> <para>The <i>DescribeEvents</i> operation 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> <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="describeEventsRequest">Container for the necessary parameters to execute the DescribeEvents service method on AmazonElastiCache.</param> <returns>The response from the DescribeEvents service method, as returned by AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.BeginDescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"/> </summary> <param name="describeEventsRequest">Container for the necessary parameters to execute the DescribeEvents operation on AmazonElastiCache.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEvents operation.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.EndDescribeEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEvents operation. <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEvents.</param> <returns>Returns a DescribeEventsResult from AmazonElastiCache.</returns> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheClient.DescribeEvents"> <summary> <para>The <i>DescribeEvents</i> operation 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> <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 AmazonElastiCache.</returns> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"/> </member> <member name="T:Amazon.ElastiCache.AmazonElastiCacheConfig"> <summary> Configuration for accessing Amazon ElastiCache service </summary> </member> <member name="M:Amazon.ElastiCache.AmazonElastiCacheConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.ElastiCache.AmazonElastiCacheConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.ElastiCache.AmazonElastiCacheConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.ElastiCache.Model.AuthorizationAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.AuthorizationAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new AuthorizationAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.AuthorizationNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.AuthorizationNotFoundException.#ctor(System.String)"> <summary> Constructs a new AuthorizationNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest"> <summary> Container for the parameters to the AuthorizeCacheSecurityGroupIngress operation. <para>The <i>AuthorizeCacheSecurityGroupIngress</i> operation 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.</para> <para><b>NOTE:</b> You cannot authorize ingress from an Amazon EC2 security group in one Region to an ElastiCache cluster in another Region. </para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.AuthorizeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest.WithCacheSecurityGroupName(System.String)"> <summary> Sets the CacheSecurityGroupName property </summary> <param name="cacheSecurityGroupName">The value to set for the CacheSecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest.WithEC2SecurityGroupName(System.String)"> <summary> Sets the EC2SecurityGroupName property </summary> <param name="eC2SecurityGroupName">The value to set for the EC2SecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest.WithEC2SecurityGroupOwnerId(System.String)"> <summary> Sets the EC2SecurityGroupOwnerId property </summary> <param name="eC2SecurityGroupOwnerId">The value to set for the EC2SecurityGroupOwnerId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest.CacheSecurityGroupName"> <summary> The cache security group which will allow network ingress. </summary> </member> <member name="P:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest.EC2SecurityGroupName"> <summary> The Amazon EC2 security group to be authorized for ingress to the cache security group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressRequest.EC2SecurityGroupOwnerId"> <summary> The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter. </summary> </member> <member name="T:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressResponse"> <summary> Returns information about the AuthorizeCacheSecurityGroupIngress response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressResponse.AuthorizeCacheSecurityGroupIngressResult"> Gets and sets the AuthorizeCacheSecurityGroupIngressResult property. Contains the result of a successful invocation of the AuthorizeCacheSecurityGroupIngress action. </member> <member name="T:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressResult"> <summary> The results from the AuthorizeCacheSecurityGroupIngress action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.AuthorizeCacheSecurityGroupIngressResult.CacheSecurityGroup"> <summary> Gets and sets the AuthorizeCacheSecurityGroupIngressResult property. Contains the result of a successful invocation of the AuthorizeCacheSecurityGroupIngress action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.AvailabilityZone"> <summary> <para>Describes an availability zone in which the cache cluster is launched.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.AvailabilityZone.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.AvailabilityZone.Name"> <summary> The name of the availability zone. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheCluster"> <summary> <para>Contains all of the attributes of a specific cache cluster.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithConfigurationEndpoint(Amazon.ElastiCache.Model.Endpoint)"> <summary> Sets the ConfigurationEndpoint property </summary> <param name="configurationEndpoint">The value to set for the ConfigurationEndpoint property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithClientDownloadLandingPage(System.String)"> <summary> Sets the ClientDownloadLandingPage property </summary> <param name="clientDownloadLandingPage">The value to set for the ClientDownloadLandingPage property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithEngine(System.String)"> <summary> Sets the Engine property </summary> <param name="engine">The value to set for the Engine property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheClusterStatus(System.String)"> <summary> Sets the CacheClusterStatus property </summary> <param name="cacheClusterStatus">The value to set for the CacheClusterStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithNumCacheNodes(System.Int32)"> <summary> Sets the NumCacheNodes property </summary> <param name="numCacheNodes">The value to set for the NumCacheNodes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithPreferredAvailabilityZone(System.String)"> <summary> Sets the PreferredAvailabilityZone property </summary> <param name="preferredAvailabilityZone">The value to set for the PreferredAvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheClusterCreateTime(System.DateTime)"> <summary> Sets the CacheClusterCreateTime property </summary> <param name="cacheClusterCreateTime">The value to set for the CacheClusterCreateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithPreferredMaintenanceWindow(System.String)"> <summary> Sets the PreferredMaintenanceWindow property </summary> <param name="preferredMaintenanceWindow">The value to set for the PreferredMaintenanceWindow property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithPendingModifiedValues(Amazon.ElastiCache.Model.PendingModifiedValues)"> <summary> Sets the PendingModifiedValues property </summary> <param name="pendingModifiedValues">The value to set for the PendingModifiedValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithNotificationConfiguration(Amazon.ElastiCache.Model.NotificationConfiguration)"> <summary> Sets the NotificationConfiguration property </summary> <param name="notificationConfiguration">The value to set for the NotificationConfiguration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheSecurityGroups(Amazon.ElastiCache.Model.CacheSecurityGroupMembership[])"> <summary> Adds elements to the CacheSecurityGroups collection </summary> <param name="cacheSecurityGroups">The values to add to the CacheSecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheSecurityGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheSecurityGroupMembership})"> <summary> Adds elements to the CacheSecurityGroups collection </summary> <param name="cacheSecurityGroups">The values to add to the CacheSecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheParameterGroup(Amazon.ElastiCache.Model.CacheParameterGroupStatus)"> <summary> Sets the CacheParameterGroup property </summary> <param name="cacheParameterGroup">The value to set for the CacheParameterGroup property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheNodes(Amazon.ElastiCache.Model.CacheNode[])"> <summary> Adds elements to the CacheNodes collection </summary> <param name="cacheNodes">The values to add to the CacheNodes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithCacheNodes(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheNode})"> <summary> Adds elements to the CacheNodes collection </summary> <param name="cacheNodes">The values to add to the CacheNodes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithAutoMinorVersionUpgrade(System.Boolean)"> <summary> Sets the AutoMinorVersionUpgrade property </summary> <param name="autoMinorVersionUpgrade">The value to set for the AutoMinorVersionUpgrade property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithSecurityGroups(Amazon.ElastiCache.Model.SecurityGroupMembership[])"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithSecurityGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.SecurityGroupMembership})"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithReplicationGroupId(System.String)"> <summary> Sets the ReplicationGroupId property </summary> <param name="replicationGroupId">The value to set for the ReplicationGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithSnapshotRetentionLimit(System.Int32)"> <summary> Sets the SnapshotRetentionLimit property </summary> <param name="snapshotRetentionLimit">The value to set for the SnapshotRetentionLimit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheCluster.WithSnapshotWindow(System.String)"> <summary> Sets the SnapshotWindow property </summary> <param name="snapshotWindow">The value to set for the SnapshotWindow property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheClusterId"> <summary> The user-supplied identifier of the cache cluster. This is a unique key that identifies a cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.ConfigurationEndpoint"> <summary> Represents the information required for client programs to connect to a cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.ClientDownloadLandingPage"> <summary> The URL of the web page where you can download the latest ElastiCache client library. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheNodeType"> <summary> The name of the compute and memory capacity node type for the cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.Engine"> <summary> The name of the cache engine (<i>memcached</i> or <i>redis</i>) to be used for this cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.EngineVersion"> <summary> The version of the cache engine version that is used in this cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheClusterStatus"> <summary> The current state of this cache cluster - <i>creating</i>, <i>available</i>, etc. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.NumCacheNodes"> <summary> The number of cache nodes in the cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.PreferredAvailabilityZone"> <summary> The name of the Availability Zone in which the cache cluster is located. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheClusterCreateTime"> <summary> The date and time when the cache cluster was created. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.PreferredMaintenanceWindow"> <summary> The time range (in UTC) during which weekly system maintenance can occur. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.PendingModifiedValues"> <summary> A group of settings that will be applied to the cache cluster in the future, or that are currently being applied. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.NotificationConfiguration"> <summary> Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS). </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheSecurityGroups"> <summary> A list of cache security group elements, composed of name and status sub-elements. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheParameterGroup"> <summary> The status of the cache parameter group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheSubnetGroupName"> <summary> The name of the cache subnet group associated with the cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.CacheNodes"> <summary> A list of cache nodes that are members of the cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.AutoMinorVersionUpgrade"> <summary> If <c>true</c>, then minor version patches are applied automatically; if <c>false</c>, then automatic minor version patches are disabled. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.SecurityGroups"> <summary> A list of VPC Security Groups associated with the cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.ReplicationGroupId"> <summary> The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.SnapshotRetentionLimit"> <summary> The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheCluster.SnapshotWindow"> <summary> The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: <c>05:00-09:00</c> </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheClusterAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheClusterAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new CacheClusterAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheClusterNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheClusterNotFoundException.#ctor(System.String)"> <summary> Constructs a new CacheClusterNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheEngineVersion"> <summary> <para>Provides all of the details about a particular cache engine version.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheEngineVersion.WithEngine(System.String)"> <summary> Sets the Engine property </summary> <param name="engine">The value to set for the Engine property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheEngineVersion.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheEngineVersion.WithCacheParameterGroupFamily(System.String)"> <summary> Sets the CacheParameterGroupFamily property </summary> <param name="cacheParameterGroupFamily">The value to set for the CacheParameterGroupFamily property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheEngineVersion.WithCacheEngineDescription(System.String)"> <summary> Sets the CacheEngineDescription property </summary> <param name="cacheEngineDescription">The value to set for the CacheEngineDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheEngineVersion.WithCacheEngineVersionDescription(System.String)"> <summary> Sets the CacheEngineVersionDescription property </summary> <param name="cacheEngineVersionDescription">The value to set for the CacheEngineVersionDescription property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheEngineVersion.Engine"> <summary> The name of the cache engine. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheEngineVersion.EngineVersion"> <summary> The version number of the cache engine. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheEngineVersion.CacheParameterGroupFamily"> <summary> The name of the cache parameter group family associated with this cache engine. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheEngineVersion.CacheEngineDescription"> <summary> The description of the cache engine. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheEngineVersion.CacheEngineVersionDescription"> <summary> The description of the cache engine version. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheNode"> <summary> <para>Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheNode.WithCacheNodeId(System.String)"> <summary> Sets the CacheNodeId property </summary> <param name="cacheNodeId">The value to set for the CacheNodeId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNode.WithCacheNodeStatus(System.String)"> <summary> Sets the CacheNodeStatus property </summary> <param name="cacheNodeStatus">The value to set for the CacheNodeStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNode.WithCacheNodeCreateTime(System.DateTime)"> <summary> Sets the CacheNodeCreateTime property </summary> <param name="cacheNodeCreateTime">The value to set for the CacheNodeCreateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNode.WithEndpoint(Amazon.ElastiCache.Model.Endpoint)"> <summary> Sets the Endpoint property </summary> <param name="endpoint">The value to set for the Endpoint property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNode.WithParameterGroupStatus(System.String)"> <summary> Sets the ParameterGroupStatus property </summary> <param name="parameterGroupStatus">The value to set for the ParameterGroupStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNode.WithSourceCacheNodeId(System.String)"> <summary> Sets the SourceCacheNodeId property </summary> <param name="sourceCacheNodeId">The value to set for the SourceCacheNodeId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheNode.CacheNodeId"> <summary> The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNode.CacheNodeStatus"> <summary> The current state of this cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNode.CacheNodeCreateTime"> <summary> The date and time when the cache node was created. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNode.Endpoint"> <summary> The hostname and IP address for connecting to this cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNode.ParameterGroupStatus"> <summary> The status of the parameter group applied to this cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNode.SourceCacheNodeId"> <summary> The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter"> <summary> <para>A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a <i>cache.m1.large</i> cache node type would have a larger <i>maxmemory</i> value than a <i>cache.m1.small</i> type.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithParameterName(System.String)"> <summary> Sets the ParameterName property </summary> <param name="parameterName">The value to set for the ParameterName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithSource(System.String)"> <summary> Sets the Source property </summary> <param name="source">The value to set for the Source property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithDataType(System.String)"> <summary> Sets the DataType property </summary> <param name="dataType">The value to set for the DataType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithAllowedValues(System.String)"> <summary> Sets the AllowedValues property </summary> <param name="allowedValues">The value to set for the AllowedValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithIsModifiable(System.Boolean)"> <summary> Sets the IsModifiable property </summary> <param name="isModifiable">The value to set for the IsModifiable property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithMinimumEngineVersion(System.String)"> <summary> Sets the MinimumEngineVersion property </summary> <param name="minimumEngineVersion">The value to set for the MinimumEngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithCacheNodeTypeSpecificValues(Amazon.ElastiCache.Model.CacheNodeTypeSpecificValue[])"> <summary> Adds elements to the CacheNodeTypeSpecificValues collection </summary> <param name="cacheNodeTypeSpecificValues">The values to add to the CacheNodeTypeSpecificValues collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.WithCacheNodeTypeSpecificValues(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheNodeTypeSpecificValue})"> <summary> Adds elements to the CacheNodeTypeSpecificValues collection </summary> <param name="cacheNodeTypeSpecificValues">The values to add to the CacheNodeTypeSpecificValues collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.ParameterName"> <summary> The name of the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.Description"> <summary> A description of the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.Source"> <summary> The source of the parameter value. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.DataType"> <summary> The valid data type for the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.AllowedValues"> <summary> The valid range of values for the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.IsModifiable"> <summary> Indicates whether (<c>true</c>) or not (<c>false</c>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.MinimumEngineVersion"> <summary> The earliest cache engine version to which the parameter can apply. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter.CacheNodeTypeSpecificValues"> <summary> A list of cache node types and their corresponding values for this parameter. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheNodeTypeSpecificValue"> <summary> <para>A value that applies only to a certain cache node type.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificValue.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheNodeTypeSpecificValue.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificValue.CacheNodeType"> <summary> The cache node type for which this value applies. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheNodeTypeSpecificValue.Value"> <summary> The value for the cache node type. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheParameterGroup"> <summary> <para>Represents the output of a <i>CreateCacheParameterGroup</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroup.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroup.WithCacheParameterGroupFamily(System.String)"> <summary> Sets the CacheParameterGroupFamily property </summary> <param name="cacheParameterGroupFamily">The value to set for the CacheParameterGroupFamily property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroup.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheParameterGroup.CacheParameterGroupName"> <summary> The name of the cache parameter group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheParameterGroup.CacheParameterGroupFamily"> <summary> The name of the cache parameter group family that this cache parameter group is compatible with. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheParameterGroup.Description"> <summary> The description for this cache parameter group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheParameterGroupAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroupAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new CacheParameterGroupAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroupNotFoundException.#ctor(System.String)"> <summary> Constructs a new CacheParameterGroupNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheParameterGroupQuotaExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroupQuotaExceededException.#ctor(System.String)"> <summary> Constructs a new CacheParameterGroupQuotaExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheParameterGroupStatus"> <summary> <para>The status of the cache parameter group.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroupStatus.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroupStatus.WithParameterApplyStatus(System.String)"> <summary> Sets the ParameterApplyStatus property </summary> <param name="parameterApplyStatus">The value to set for the ParameterApplyStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroupStatus.WithCacheNodeIdsToReboot(System.String[])"> <summary> Adds elements to the CacheNodeIdsToReboot collection </summary> <param name="cacheNodeIdsToReboot">The values to add to the CacheNodeIdsToReboot collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheParameterGroupStatus.WithCacheNodeIdsToReboot(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CacheNodeIdsToReboot collection </summary> <param name="cacheNodeIdsToReboot">The values to add to the CacheNodeIdsToReboot collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheParameterGroupStatus.CacheParameterGroupName"> <summary> The name of the cache parameter group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheParameterGroupStatus.ParameterApplyStatus"> <summary> The status of parameter updates. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheParameterGroupStatus.CacheNodeIdsToReboot"> <summary> A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.). </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheSecurityGroup"> <summary> <para>Represents the output of one of the following operations:</para> <ul> <li> <i>AuthorizeCacheSecurityGroupIngress</i> </li> <li> <i>CreateCacheSecurityGroup</i> </li> <li> <i>RevokeCacheSecurityGroupIngress</i> </li> </ul> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroup.WithOwnerId(System.String)"> <summary> Sets the OwnerId property </summary> <param name="ownerId">The value to set for the OwnerId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroup.WithCacheSecurityGroupName(System.String)"> <summary> Sets the CacheSecurityGroupName property </summary> <param name="cacheSecurityGroupName">The value to set for the CacheSecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroup.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroup.WithEC2SecurityGroups(Amazon.ElastiCache.Model.EC2SecurityGroup[])"> <summary> Adds elements to the EC2SecurityGroups collection </summary> <param name="eC2SecurityGroups">The values to add to the EC2SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroup.WithEC2SecurityGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.EC2SecurityGroup})"> <summary> Adds elements to the EC2SecurityGroups collection </summary> <param name="eC2SecurityGroups">The values to add to the EC2SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheSecurityGroup.OwnerId"> <summary> The AWS account ID of the cache security group owner. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheSecurityGroup.CacheSecurityGroupName"> <summary> The name of the cache security group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheSecurityGroup.Description"> <summary> The description of the cache security group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheSecurityGroup.EC2SecurityGroups"> <summary> A list of Amazon EC2 security groups that are associated with this cache security group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheSecurityGroupAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroupAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new CacheSecurityGroupAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheSecurityGroupMembership"> <summary> <para>Represents a cache cluster's status within a particular cache security group.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroupMembership.WithCacheSecurityGroupName(System.String)"> <summary> Sets the CacheSecurityGroupName property </summary> <param name="cacheSecurityGroupName">The value to set for the CacheSecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroupMembership.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheSecurityGroupMembership.CacheSecurityGroupName"> <summary> The name of the cache security group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheSecurityGroupMembership.Status"> <summary> The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroupNotFoundException.#ctor(System.String)"> <summary> Constructs a new CacheSecurityGroupNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheSecurityGroupQuotaExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSecurityGroupQuotaExceededException.#ctor(System.String)"> <summary> Constructs a new CacheSecurityGroupQuotaExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheSubnetGroup"> <summary> <para>Represents the output of one of the following operations:</para> <ul> <li> <i>CreateCacheSubnetGroup</i> </li> <li> <i>ModifyCacheSubnetGroup</i> </li> </ul> </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroup.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroup.WithCacheSubnetGroupDescription(System.String)"> <summary> Sets the CacheSubnetGroupDescription property </summary> <param name="cacheSubnetGroupDescription">The value to set for the CacheSubnetGroupDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroup.WithVpcId(System.String)"> <summary> Sets the VpcId property </summary> <param name="vpcId">The value to set for the VpcId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroup.WithSubnets(Amazon.ElastiCache.Model.Subnet[])"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroup.WithSubnets(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.Subnet})"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CacheSubnetGroup.CacheSubnetGroupName"> <summary> The name of the cache subnet group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheSubnetGroup.CacheSubnetGroupDescription"> <summary> The description of the cache subnet group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheSubnetGroup.VpcId"> <summary> The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CacheSubnetGroup.Subnets"> <summary> A list of subnets associated with the cache subnet group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CacheSubnetGroupAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroupAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new CacheSubnetGroupAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheSubnetGroupInUseException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroupInUseException.#ctor(System.String)"> <summary> Constructs a new CacheSubnetGroupInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroupNotFoundException.#ctor(System.String)"> <summary> Constructs a new CacheSubnetGroupNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheSubnetGroupQuotaExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetGroupQuotaExceededException.#ctor(System.String)"> <summary> Constructs a new CacheSubnetGroupQuotaExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.CacheSubnetQuotaExceededException.#ctor(System.String)"> <summary> Constructs a new CacheSubnetQuotaExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.ClusterQuotaForCustomerExceededException.#ctor(System.String)"> <summary> Constructs a new ClusterQuotaForCustomerExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.CopySnapshotRequest"> <summary> Container for the parameters to the CopySnapshot operation. <para>The <i>CopySnapshot</i> operation makes a copy of an existing snapshot.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CopySnapshot(Amazon.ElastiCache.Model.CopySnapshotRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.CopySnapshotRequest.WithSourceSnapshotName(System.String)"> <summary> Sets the SourceSnapshotName property </summary> <param name="sourceSnapshotName">The value to set for the SourceSnapshotName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CopySnapshotRequest.WithTargetSnapshotName(System.String)"> <summary> Sets the TargetSnapshotName property </summary> <param name="targetSnapshotName">The value to set for the TargetSnapshotName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CopySnapshotRequest.SourceSnapshotName"> <summary> The name of an existing snapshot from which to copy. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CopySnapshotRequest.TargetSnapshotName"> <summary> A name for the copied snapshot. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CopySnapshotResponse"> <summary> Returns information about the CopySnapshot response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CopySnapshotResponse.CopySnapshotResult"> Gets and sets the CopySnapshotResult property. Contains the result of a successful invocation of the CopySnapshot action. </member> <member name="T:Amazon.ElastiCache.Model.CopySnapshotResult"> <summary> The results from the CopySnapshot action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CopySnapshotResult.Snapshot"> <summary> Gets and sets the CopySnapshotResult property. Contains the result of a successful invocation of the CopySnapshot action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheClusterRequest"> <summary> Container for the parameters to the CreateCacheCluster operation. <para>The <i>CreateCacheCluster</i> operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheCluster(Amazon.ElastiCache.Model.CreateCacheClusterRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithReplicationGroupId(System.String)"> <summary> Sets the ReplicationGroupId property </summary> <param name="replicationGroupId">The value to set for the ReplicationGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithNumCacheNodes(System.Int32)"> <summary> Sets the NumCacheNodes property </summary> <param name="numCacheNodes">The value to set for the NumCacheNodes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithEngine(System.String)"> <summary> Sets the Engine property </summary> <param name="engine">The value to set for the Engine property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithCacheSecurityGroupNames(System.String[])"> <summary> Adds elements to the CacheSecurityGroupNames collection </summary> <param name="cacheSecurityGroupNames">The values to add to the CacheSecurityGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithCacheSecurityGroupNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CacheSecurityGroupNames collection </summary> <param name="cacheSecurityGroupNames">The values to add to the CacheSecurityGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithSecurityGroupIds(System.String[])"> <summary> Adds elements to the SecurityGroupIds collection </summary> <param name="securityGroupIds">The values to add to the SecurityGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithSecurityGroupIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SecurityGroupIds collection </summary> <param name="securityGroupIds">The values to add to the SecurityGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithSnapshotArns(System.String[])"> <summary> Adds elements to the SnapshotArns collection </summary> <param name="snapshotArns">The values to add to the SnapshotArns collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithSnapshotArns(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SnapshotArns collection </summary> <param name="snapshotArns">The values to add to the SnapshotArns collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithSnapshotName(System.String)"> <summary> Sets the SnapshotName property </summary> <param name="snapshotName">The value to set for the SnapshotName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithPreferredAvailabilityZone(System.String)"> <summary> Sets the PreferredAvailabilityZone property </summary> <param name="preferredAvailabilityZone">The value to set for the PreferredAvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithPreferredMaintenanceWindow(System.String)"> <summary> Sets the PreferredMaintenanceWindow property </summary> <param name="preferredMaintenanceWindow">The value to set for the PreferredMaintenanceWindow property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithPort(System.Int32)"> <summary> Sets the Port property </summary> <param name="port">The value to set for the Port property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithNotificationTopicArn(System.String)"> <summary> Sets the NotificationTopicArn property </summary> <param name="notificationTopicArn">The value to set for the NotificationTopicArn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithAutoMinorVersionUpgrade(System.Boolean)"> <summary> Sets the AutoMinorVersionUpgrade property </summary> <param name="autoMinorVersionUpgrade">The value to set for the AutoMinorVersionUpgrade property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithSnapshotRetentionLimit(System.Int32)"> <summary> Sets the SnapshotRetentionLimit property </summary> <param name="snapshotRetentionLimit">The value to set for the SnapshotRetentionLimit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheClusterRequest.WithSnapshotWindow(System.String)"> <summary> Sets the SnapshotWindow property </summary> <param name="snapshotWindow">The value to set for the SnapshotWindow property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.CacheClusterId"> <summary> The cache cluster identifier. This parameter is stored as a lowercase string. Constraints: <ul> <li>Must contain from 1 to 20 alphanumeric characters or hyphens.</li> <li>First character must be a letter.</li> <li>Cannot end with a hyphen or contain two consecutive hyphens.</li> </ul> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.ReplicationGroupId"> <summary> The replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.NumCacheNodes"> <summary> The initial number of cache nodes that the cache cluster will have. For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at <a href="http://aws.amazon.com/contact-us/elasticache-node-limit-request/"/> . For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.CacheNodeType"> <summary> The compute and memory capacity of the nodes in the cache cluster. Valid values for Memcached: <c>cache.t1.micro</c> | <c>cache.m1.small</c> | <c>cache.m1.medium</c> | <c>cache.m1.large</c> | <c>cache.m1.xlarge</c> | <c>cache.m3.xlarge</c> | <c>cache.m3.2xlarge</c> | <c>cache.m2.xlarge</c> | <c>cache.m2.2xlarge</c> | <c>cache.m2.4xlarge</c> | <c>cache.c1.xlarge</c> Valid values for Redis: <c>cache.t1.micro</c> | <c>cache.m1.small</c> | <c>cache.m1.medium</c> | <c>cache.m1.large</c> | <c>cache.m1.xlarge</c> | <c>cache.m2.xlarge</c> | <c>cache.m2.2xlarge</c> | <c>cache.m2.4xlarge</c> | <c>cache.c1.xlarge</c> For a complete listing of cache node types and specifications, see <a href="http://aws.amazon.com/elasticache/"/>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.Engine"> <summary> The name of the cache engine to be used for this cache cluster. Valid values for this parameter are: <c>memcached</c> | <c>redis</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.EngineVersion"> <summary> The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the <i>DescribeCacheEngineVersions</i> operation. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.CacheParameterGroupName"> <summary> The name of the cache parameter group to associate with this cache cluster. If this argument is omitted, the default cache parameter group for the specified engine will be used. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.CacheSubnetGroupName"> <summary> The name of the cache subnet group to be used for the cache cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC). </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.CacheSecurityGroupNames"> <summary> A list of cache security group names to associate with this cache cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.SecurityGroupIds"> <summary> One or more VPC security groups associated with the cache cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC). </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.SnapshotArns"> <summary> A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas. Here is an example of an Amazon S3 ARN: <c>arn:aws:s3:::my_bucket/snapshot1.rdb</c> <b>Note:</b> This parameter is only valid if the <c>Engine</c> parameter is <c>redis</c>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.SnapshotName"> <summary> The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to <c>restoring</c> while the new cache cluster is being created. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.PreferredAvailabilityZone"> <summary> The EC2 Availability Zone in which the cache cluster will be created. All cache nodes belonging to a cache cluster are placed in the preferred availability zone. Default: System chosen availability zone. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.PreferredMaintenanceWindow"> <summary> The weekly time range (in UTC) during which system maintenance can occur. Example: <c>sun:05:00-sun:09:00</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.Port"> <summary> The port number on which each of the cache nodes will accept connections. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.NotificationTopicArn"> <summary> The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. <note> The Amazon SNS topic owner must be the same as the cache cluster owner. </note> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.AutoMinorVersionUpgrade"> <summary> Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of <c>true</c> allows these upgrades to occur; <c>false</c> disables automatic upgrades. Default: <c>true</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.SnapshotRetentionLimit"> <summary> The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If you do not specify this parameter, then <i>SnapshotRetentionLimit</i> will be set to 0 (i.e., automatic backups will be disabled for this cache cluster). </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterRequest.SnapshotWindow"> <summary> The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: <c>05:00-09:00</c> If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheClusterResponse"> <summary> Returns information about the CreateCacheCluster response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterResponse.CreateCacheClusterResult"> Gets and sets the CreateCacheClusterResult property. Contains the result of a successful invocation of the CreateCacheCluster action. </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheClusterResult"> <summary> The results from the CreateCacheCluster action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheClusterResult.CacheCluster"> <summary> Gets and sets the CreateCacheClusterResult property. Contains the result of a successful invocation of the CreateCacheCluster action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest"> <summary> Container for the parameters to the CreateCacheParameterGroup operation. <para>The <i>CreateCacheParameterGroup</i> operation 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.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheParameterGroup(Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest.WithCacheParameterGroupFamily(System.String)"> <summary> Sets the CacheParameterGroupFamily property </summary> <param name="cacheParameterGroupFamily">The value to set for the CacheParameterGroupFamily property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest.CacheParameterGroupName"> <summary> A user-specified name for the cache parameter group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest.CacheParameterGroupFamily"> <summary> The name of the cache parameter group family the cache parameter group can be used with. Valid values are: <c>memcached1.4</c> | <c>redis2.6</c> | <c>redis2.8</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheParameterGroupRequest.Description"> <summary> A user-specified description for the cache parameter group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheParameterGroupResponse"> <summary> Returns information about the CreateCacheParameterGroup response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheParameterGroupResponse.CreateCacheParameterGroupResult"> Gets and sets the CreateCacheParameterGroupResult property. Contains the result of a successful invocation of the CreateCacheParameterGroup action. </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheParameterGroupResult"> <summary> The results from the CreateCacheParameterGroup action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheParameterGroupResult.CacheParameterGroup"> <summary> Gets and sets the CreateCacheParameterGroupResult property. Contains the result of a successful invocation of the CreateCacheParameterGroup action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest"> <summary> Container for the parameters to the CreateCacheSecurityGroup operation. <para>The <i>CreateCacheSecurityGroup</i> operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.</para> <para>Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see <i>CreateCacheSubnetGroup</i> .</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSecurityGroup(Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest.WithCacheSecurityGroupName(System.String)"> <summary> Sets the CacheSecurityGroupName property </summary> <param name="cacheSecurityGroupName">The value to set for the CacheSecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest.CacheSecurityGroupName"> <summary> A name for the cache security group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word "Default". Example: <c>mysecuritygroup</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSecurityGroupRequest.Description"> <summary> A description for the cache security group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheSecurityGroupResponse"> <summary> Returns information about the CreateCacheSecurityGroup response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSecurityGroupResponse.CreateCacheSecurityGroupResult"> Gets and sets the CreateCacheSecurityGroupResult property. Contains the result of a successful invocation of the CreateCacheSecurityGroup action. </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheSecurityGroupResult"> <summary> The results from the CreateCacheSecurityGroup action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSecurityGroupResult.CacheSecurityGroup"> <summary> Gets and sets the CreateCacheSecurityGroupResult property. Contains the result of a successful invocation of the CreateCacheSecurityGroup action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest"> <summary> Container for the parameters to the CreateCacheSubnetGroup operation. <para>The <i>CreateCacheSubnetGroup</i> operation creates a new cache subnet group.</para> <para>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateCacheSubnetGroup(Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest.WithCacheSubnetGroupDescription(System.String)"> <summary> Sets the CacheSubnetGroupDescription property </summary> <param name="cacheSubnetGroupDescription">The value to set for the CacheSubnetGroupDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest.WithSubnetIds(System.String[])"> <summary> Adds elements to the SubnetIds collection </summary> <param name="subnetIds">The values to add to the SubnetIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest.WithSubnetIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SubnetIds collection </summary> <param name="subnetIds">The values to add to the SubnetIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest.CacheSubnetGroupName"> <summary> A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: <c>mysubnetgroup</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest.CacheSubnetGroupDescription"> <summary> A description for the cache subnet group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSubnetGroupRequest.SubnetIds"> <summary> A list of VPC subnet IDs for the cache subnet group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheSubnetGroupResponse"> <summary> Returns information about the CreateCacheSubnetGroup response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSubnetGroupResponse.CreateCacheSubnetGroupResult"> Gets and sets the CreateCacheSubnetGroupResult property. Contains the result of a successful invocation of the CreateCacheSubnetGroup action. </member> <member name="T:Amazon.ElastiCache.Model.CreateCacheSubnetGroupResult"> <summary> The results from the CreateCacheSubnetGroup action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateCacheSubnetGroupResult.CacheSubnetGroup"> <summary> Gets and sets the CreateCacheSubnetGroupResult property. Contains the result of a successful invocation of the CreateCacheSubnetGroup action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateReplicationGroupRequest"> <summary> Container for the parameters to the CreateReplicationGroup operation. <para>The <i>CreateReplicationGroup</i> operation creates a replication group. A replication group is a collection of cache clusters, where one of the clusters is a read/write primary and the other clusters are read-only replicas. Writes to the primary are automatically propagated to the replicas.</para> <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> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateReplicationGroup(Amazon.ElastiCache.Model.CreateReplicationGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.CreateReplicationGroupRequest.WithReplicationGroupId(System.String)"> <summary> Sets the ReplicationGroupId property </summary> <param name="replicationGroupId">The value to set for the ReplicationGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateReplicationGroupRequest.WithPrimaryClusterId(System.String)"> <summary> Sets the PrimaryClusterId property </summary> <param name="primaryClusterId">The value to set for the PrimaryClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateReplicationGroupRequest.WithReplicationGroupDescription(System.String)"> <summary> Sets the ReplicationGroupDescription property </summary> <param name="replicationGroupDescription">The value to set for the ReplicationGroupDescription property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CreateReplicationGroupRequest.ReplicationGroupId"> <summary> The replication group identifier. This parameter is stored as a lowercase string. Constraints: <ul> <li>Must contain from 1 to 20 alphanumeric characters or hyphens.</li> <li>First character must be a letter.</li> <li>Cannot end with a hyphen or contain two consecutive hyphens.</li> </ul> </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateReplicationGroupRequest.PrimaryClusterId"> <summary> The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of <i>available</i>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateReplicationGroupRequest.ReplicationGroupDescription"> <summary> A user-specified description for the replication group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateReplicationGroupResponse"> <summary> Returns information about the CreateReplicationGroup response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateReplicationGroupResponse.CreateReplicationGroupResult"> Gets and sets the CreateReplicationGroupResult property. Contains the result of a successful invocation of the CreateReplicationGroup action. </member> <member name="T:Amazon.ElastiCache.Model.CreateReplicationGroupResult"> <summary> The results from the CreateReplicationGroup action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateReplicationGroupResult.ReplicationGroup"> <summary> Gets and sets the CreateReplicationGroupResult property. Contains the result of a successful invocation of the CreateReplicationGroup action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateSnapshotRequest"> <summary> Container for the parameters to the CreateSnapshot operation. <para>The <i>CreateSnapshot</i> operation creates a copy of an entire cache cluster at a specific moment in time.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.CreateSnapshot(Amazon.ElastiCache.Model.CreateSnapshotRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.CreateSnapshotRequest.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.CreateSnapshotRequest.WithSnapshotName(System.String)"> <summary> Sets the SnapshotName property </summary> <param name="snapshotName">The value to set for the SnapshotName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.CreateSnapshotRequest.CacheClusterId"> <summary> The identifier of an existing cache cluster. The snapshot will be created from this cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateSnapshotRequest.SnapshotName"> <summary> A name for the snapshot being created. </summary> </member> <member name="T:Amazon.ElastiCache.Model.CreateSnapshotResponse"> <summary> Returns information about the CreateSnapshot response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateSnapshotResponse.CreateSnapshotResult"> Gets and sets the CreateSnapshotResult property. Contains the result of a successful invocation of the CreateSnapshot action. </member> <member name="T:Amazon.ElastiCache.Model.CreateSnapshotResult"> <summary> The results from the CreateSnapshot action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.CreateSnapshotResult.Snapshot"> <summary> Gets and sets the CreateSnapshotResult property. Contains the result of a successful invocation of the CreateSnapshot action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheClusterRequest"> <summary> Container for the parameters to the DeleteCacheCluster operation. <para>The <i>DeleteCacheCluster</i> operation 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 operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheCluster(Amazon.ElastiCache.Model.DeleteCacheClusterRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DeleteCacheClusterRequest.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DeleteCacheClusterRequest.WithFinalSnapshotIdentifier(System.String)"> <summary> Sets the FinalSnapshotIdentifier property </summary> <param name="finalSnapshotIdentifier">The value to set for the FinalSnapshotIdentifier property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DeleteCacheClusterRequest.CacheClusterId"> <summary> The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteCacheClusterRequest.FinalSnapshotIdentifier"> <summary> The name of a final cache cluster snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheClusterResponse"> <summary> Returns information about the DeleteCacheCluster response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteCacheClusterResponse.DeleteCacheClusterResult"> Gets and sets the DeleteCacheClusterResult property. Contains the result of a successful invocation of the DeleteCacheCluster action. </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheClusterResult"> <summary> The results from the DeleteCacheCluster action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteCacheClusterResult.CacheCluster"> <summary> Gets and sets the DeleteCacheClusterResult property. Contains the result of a successful invocation of the DeleteCacheCluster action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest"> <summary> Container for the parameters to the DeleteCacheParameterGroup operation. <para>The <i>DeleteCacheParameterGroup</i> operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheParameterGroup(Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DeleteCacheParameterGroupRequest.CacheParameterGroupName"> <summary> The name of the cache parameter group to delete. <note> The specified cache security group must not be associated with any cache clusters. </note> </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheParameterGroupResponse"> <summary> Returns information about the DeleteCacheParameterGroup response metadata. The DeleteCacheParameterGroup operation has a void result type. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest"> <summary> Container for the parameters to the DeleteCacheSecurityGroup operation. <para>The <i>DeleteCacheSecurityGroup</i> operation deletes a cache security group.</para> <para><b>NOTE:</b>You cannot delete a cache security group if it is associated with any cache clusters.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSecurityGroup(Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest.WithCacheSecurityGroupName(System.String)"> <summary> Sets the CacheSecurityGroupName property </summary> <param name="cacheSecurityGroupName">The value to set for the CacheSecurityGroupName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DeleteCacheSecurityGroupRequest.CacheSecurityGroupName"> <summary> The name of the cache security group to delete. <note>You cannot delete the default security group.</note> </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheSecurityGroupResponse"> <summary> Returns information about the DeleteCacheSecurityGroup response metadata. The DeleteCacheSecurityGroup operation has a void result type. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest"> <summary> Container for the parameters to the DeleteCacheSubnetGroup operation. <para>The <i>DeleteCacheSubnetGroup</i> operation deletes a cache subnet group.</para> <para><b>NOTE:</b>You cannot delete a cache subnet group if it is associated with any cache clusters.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteCacheSubnetGroup(Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DeleteCacheSubnetGroupRequest.CacheSubnetGroupName"> <summary> The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteCacheSubnetGroupResponse"> <summary> Returns information about the DeleteCacheSubnetGroup response metadata. The DeleteCacheSubnetGroup operation has a void result type. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteReplicationGroupRequest"> <summary> Container for the parameters to the DeleteReplicationGroup operation. <para>The <i>DeleteReplicationGroup</i> operation deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary cache cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cache cluster.</para> <para>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteReplicationGroup(Amazon.ElastiCache.Model.DeleteReplicationGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DeleteReplicationGroupRequest.WithReplicationGroupId(System.String)"> <summary> Sets the ReplicationGroupId property </summary> <param name="replicationGroupId">The value to set for the ReplicationGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DeleteReplicationGroupRequest.WithRetainPrimaryCluster(System.Boolean)"> <summary> Sets the RetainPrimaryCluster property </summary> <param name="retainPrimaryCluster">The value to set for the RetainPrimaryCluster property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DeleteReplicationGroupRequest.WithFinalSnapshotIdentifier(System.String)"> <summary> Sets the FinalSnapshotIdentifier property </summary> <param name="finalSnapshotIdentifier">The value to set for the FinalSnapshotIdentifier property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DeleteReplicationGroupRequest.ReplicationGroupId"> <summary> The identifier for the replication group to be deleted. This parameter is not case sensitive. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteReplicationGroupRequest.RetainPrimaryCluster"> <summary> If set to <i>true</i>, all of the read replicas will be deleted, but the primary cache cluster will be retained. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteReplicationGroupRequest.FinalSnapshotIdentifier"> <summary> The name of a final cache cluster snapshot. ElastiCache creates the snapshot from the primary cluster in the replication group, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is deleted immediately afterward. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteReplicationGroupResponse"> <summary> Returns information about the DeleteReplicationGroup response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteReplicationGroupResponse.DeleteReplicationGroupResult"> Gets and sets the DeleteReplicationGroupResult property. Contains the result of a successful invocation of the DeleteReplicationGroup action. </member> <member name="T:Amazon.ElastiCache.Model.DeleteReplicationGroupResult"> <summary> The results from the DeleteReplicationGroup action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteReplicationGroupResult.ReplicationGroup"> <summary> Gets and sets the DeleteReplicationGroupResult property. Contains the result of a successful invocation of the DeleteReplicationGroup action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteSnapshotRequest"> <summary> Container for the parameters to the DeleteSnapshot operation. <para>The <i>DeleteSnapshot</i> operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DeleteSnapshot(Amazon.ElastiCache.Model.DeleteSnapshotRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DeleteSnapshotRequest.WithSnapshotName(System.String)"> <summary> Sets the SnapshotName property </summary> <param name="snapshotName">The value to set for the SnapshotName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DeleteSnapshotRequest.SnapshotName"> <summary> The name of the snapshot to be deleted. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DeleteSnapshotResponse"> <summary> Returns information about the DeleteSnapshot response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteSnapshotResponse.DeleteSnapshotResult"> Gets and sets the DeleteSnapshotResult property. Contains the result of a successful invocation of the DeleteSnapshot action. </member> <member name="T:Amazon.ElastiCache.Model.DeleteSnapshotResult"> <summary> The results from the DeleteSnapshot action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DeleteSnapshotResult.Snapshot"> <summary> Gets and sets the DeleteSnapshotResult property. Contains the result of a successful invocation of the DeleteSnapshot action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheClustersRequest"> <summary> Container for the parameters to the DescribeCacheClusters operation. <para>The <i>DescribeCacheClusters</i> operation 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> <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> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheClusters(Amazon.ElastiCache.Model.DescribeCacheClustersRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.WithShowCacheNodeInfo(System.Boolean)"> <summary> Sets the ShowCacheNodeInfo property </summary> <param name="showCacheNodeInfo">The value to set for the ShowCacheNodeInfo property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.CacheClusterId"> <summary> The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheClustersRequest.ShowCacheNodeInfo"> <summary> An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheClustersResponse"> <summary> Returns information about the DescribeCacheClustersResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheClustersResponse.DescribeCacheClustersResult"> <summary> Gets and sets the DescribeCacheClustersResult property. Represents the output of a DescribeCacheClusters operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheClustersResult"> <summary> <para>Represents the output of a <i>DescribeCacheClusters</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheClustersResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheClustersResult.WithCacheClusters(Amazon.ElastiCache.Model.CacheCluster[])"> <summary> Adds elements to the CacheClusters collection </summary> <param name="cacheClusters">The values to add to the CacheClusters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheClustersResult.WithCacheClusters(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheCluster})"> <summary> Adds elements to the CacheClusters collection </summary> <param name="cacheClusters">The values to add to the CacheClusters collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheClustersResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheClustersResult.CacheClusters"> <summary> A list of cache clusters. Each item in the list contains detailed information about one cache cluster. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest"> <summary> Container for the parameters to the DescribeCacheEngineVersions operation. <para>The <i>DescribeCacheEngineVersions</i> operation returns a list of the available cache engines and their versions.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheEngineVersions(Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.WithEngine(System.String)"> <summary> Sets the Engine property </summary> <param name="engine">The value to set for the Engine property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.WithCacheParameterGroupFamily(System.String)"> <summary> Sets the CacheParameterGroupFamily property </summary> <param name="cacheParameterGroupFamily">The value to set for the CacheParameterGroupFamily property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.WithDefaultOnly(System.Boolean)"> <summary> Sets the DefaultOnly property </summary> <param name="defaultOnly">The value to set for the DefaultOnly property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.Engine"> <summary> The cache engine to return. Valid values: <c>memcached</c> | <c>redis</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.EngineVersion"> <summary> The cache engine version to return. Example: <c>1.4.14</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.CacheParameterGroupFamily"> <summary> The name of a specific cache parameter group family to return details for. Constraints: <ul> <li>Must be 1 to 255 alphanumeric characters</li> <li>First character must be a letter</li> <li>Cannot end with a hyphen or contain two consecutive hyphens</li> </ul> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsRequest.DefaultOnly"> <summary> If <i>true</i>, specifies that only the default version of the specified engine or engine and major version combination is to be returned. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResponse"> <summary> Returns information about the DescribeCacheEngineVersionsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResponse.DescribeCacheEngineVersionsResult"> <summary> Gets and sets the DescribeCacheEngineVersionsResult property. Represents the output of a DescribeCacheEngineVersions operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResult"> <summary> <para>Represents the output of a DescribeCacheEngineVersions operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResult.WithCacheEngineVersions(Amazon.ElastiCache.Model.CacheEngineVersion[])"> <summary> Adds elements to the CacheEngineVersions collection </summary> <param name="cacheEngineVersions">The values to add to the CacheEngineVersions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResult.WithCacheEngineVersions(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheEngineVersion})"> <summary> Adds elements to the CacheEngineVersions collection </summary> <param name="cacheEngineVersions">The values to add to the CacheEngineVersions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheEngineVersionsResult.CacheEngineVersions"> <summary> A list of cache engine version details. Each element in the list contains detailed information about once cache engine version. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest"> <summary> Container for the parameters to the DescribeCacheParameterGroups operation. <para>The <i>DescribeCacheParameterGroups</i> operation 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.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameterGroups(Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest.CacheParameterGroupName"> <summary> The name of a specific cache parameter group to return details for. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResponse"> <summary> Returns information about the DescribeCacheParameterGroupsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResponse.DescribeCacheParameterGroupsResult"> <summary> Gets and sets the DescribeCacheParameterGroupsResult property. Represents the output of a DescribeCacheParameterGroups operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResult"> <summary> <para>Represents the output of a <i>DescribeCacheParameterGroups</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResult.WithCacheParameterGroups(Amazon.ElastiCache.Model.CacheParameterGroup[])"> <summary> Adds elements to the CacheParameterGroups collection </summary> <param name="cacheParameterGroups">The values to add to the CacheParameterGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResult.WithCacheParameterGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheParameterGroup})"> <summary> Adds elements to the CacheParameterGroups collection </summary> <param name="cacheParameterGroups">The values to add to the CacheParameterGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParameterGroupsResult.CacheParameterGroups"> <summary> A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheParametersRequest"> <summary> Container for the parameters to the DescribeCacheParameters operation. <para>The <i>DescribeCacheParameters</i> operation returns the detailed parameter list for a particular cache parameter group.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheParameters(Amazon.ElastiCache.Model.DescribeCacheParametersRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.WithSource(System.String)"> <summary> Sets the Source property </summary> <param name="source">The value to set for the Source property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.CacheParameterGroupName"> <summary> The name of a specific cache parameter group to return details for. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.Source"> <summary> The parameter types to return. Valid values: <c>user</c> | <c>system</c> | <c>engine-default</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheParametersResponse"> <summary> Returns information about the DescribeCacheParametersResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersResponse.DescribeCacheParametersResult"> <summary> Gets and sets the DescribeCacheParametersResult property. Represents the output of a DescribeCacheParameters operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheParametersResult"> <summary> <para>Represents the output of a <i>DescribeCacheParameters</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersResult.WithParameters(Amazon.ElastiCache.Model.Parameter[])"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersResult.WithParameters(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.Parameter})"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersResult.WithCacheNodeTypeSpecificParameters(Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter[])"> <summary> Adds elements to the CacheNodeTypeSpecificParameters collection </summary> <param name="cacheNodeTypeSpecificParameters">The values to add to the CacheNodeTypeSpecificParameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheParametersResult.WithCacheNodeTypeSpecificParameters(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter})"> <summary> Adds elements to the CacheNodeTypeSpecificParameters collection </summary> <param name="cacheNodeTypeSpecificParameters">The values to add to the CacheNodeTypeSpecificParameters collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersResult.Parameters"> <summary> A list of <a>Parameter</a> instances. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheParametersResult.CacheNodeTypeSpecificParameters"> <summary> A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest"> <summary> Container for the parameters to the DescribeCacheSecurityGroups operation. <para>The <i>DescribeCacheSecurityGroups</i> operation 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.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSecurityGroups(Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest.WithCacheSecurityGroupName(System.String)"> <summary> Sets the CacheSecurityGroupName property </summary> <param name="cacheSecurityGroupName">The value to set for the CacheSecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest.CacheSecurityGroupName"> <summary> The name of the cache security group to return details for. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResponse"> <summary> Returns information about the DescribeCacheSecurityGroupsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResponse.DescribeCacheSecurityGroupsResult"> <summary> Gets and sets the DescribeCacheSecurityGroupsResult property. Represents the output of a DescribeCacheSecurityGroups operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResult"> <summary> <para>Represents the output of a <i>DescribeCacheSecurityGroups</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResult.WithCacheSecurityGroups(Amazon.ElastiCache.Model.CacheSecurityGroup[])"> <summary> Adds elements to the CacheSecurityGroups collection </summary> <param name="cacheSecurityGroups">The values to add to the CacheSecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResult.WithCacheSecurityGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheSecurityGroup})"> <summary> Adds elements to the CacheSecurityGroups collection </summary> <param name="cacheSecurityGroups">The values to add to the CacheSecurityGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSecurityGroupsResult.CacheSecurityGroups"> <summary> A list of cache security groups. Each element in the list contains detailed information about one group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest"> <summary> Container for the parameters to the DescribeCacheSubnetGroups operation. <para>The <i>DescribeCacheSubnetGroups</i> operation 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.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeCacheSubnetGroups(Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest.CacheSubnetGroupName"> <summary> The name of the cache subnet group to return details for. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResponse"> <summary> Returns information about the DescribeCacheSubnetGroupsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResponse.DescribeCacheSubnetGroupsResult"> <summary> Gets and sets the DescribeCacheSubnetGroupsResult property. Represents the output of a DescribeCacheSubnetGroups operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResult"> <summary> <para>Represents the output of a <i>DescribeCacheSubnetGroups</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResult.WithCacheSubnetGroups(Amazon.ElastiCache.Model.CacheSubnetGroup[])"> <summary> Adds elements to the CacheSubnetGroups collection </summary> <param name="cacheSubnetGroups">The values to add to the CacheSubnetGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResult.WithCacheSubnetGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheSubnetGroup})"> <summary> Adds elements to the CacheSubnetGroups collection </summary> <param name="cacheSubnetGroups">The values to add to the CacheSubnetGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeCacheSubnetGroupsResult.CacheSubnetGroups"> <summary> A list of cache subnet groups. Each element in the list contains detailed information about one group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest"> <summary> Container for the parameters to the DescribeEngineDefaultParameters operation. <para>The <i>DescribeEngineDefaultParameters</i> operation returns the default engine and system parameter information for the specified cache engine.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEngineDefaultParameters(Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest.WithCacheParameterGroupFamily(System.String)"> <summary> Sets the CacheParameterGroupFamily property </summary> <param name="cacheParameterGroupFamily">The value to set for the CacheParameterGroupFamily property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest.CacheParameterGroupFamily"> <summary> The name of the cache parameter group family. Valid values are: <c>memcached1.4</c> | <c>redis2.6</c> | <c>redis2.8</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersResponse"> <summary> Returns information about the DescribeEngineDefaultParameters response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersResponse.DescribeEngineDefaultParametersResult"> Gets and sets the DescribeEngineDefaultParametersResult property. Contains the result of a successful invocation of the DescribeEngineDefaultParameters action. </member> <member name="T:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersResult"> <summary> The results from the DescribeEngineDefaultParameters action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEngineDefaultParametersResult.EngineDefaults"> <summary> Gets and sets the DescribeEngineDefaultParametersResult property. Contains the result of a successful invocation of the DescribeEngineDefaultParameters action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeEventsRequest"> <summary> Container for the parameters to the DescribeEvents operation. <para>The <i>DescribeEvents</i> operation 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> <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> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeEvents(Amazon.ElastiCache.Model.DescribeEventsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsRequest.WithSourceIdentifier(System.String)"> <summary> Sets the SourceIdentifier property </summary> <param name="sourceIdentifier">The value to set for the SourceIdentifier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsRequest.WithSourceType(System.String)"> <summary> Sets the SourceType property </summary> <param name="sourceType">The value to set for the SourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsRequest.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsRequest.WithEndTime(System.DateTime)"> <summary> Sets the EndTime property </summary> <param name="endTime">The value to set for the EndTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsRequest.WithDuration(System.Int32)"> <summary> Sets the Duration property </summary> <param name="duration">The value to set for the Duration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsRequest.SourceIdentifier"> <summary> The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsRequest.SourceType"> <summary> The event source to retrieve events for. If no value is specified, all events are returned. Valid values are: <c>cache-cluster</c> | <c>cache-parameter-group</c> | <c>cache-security-group</c> | <c>cache-subnet-group</c> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsRequest.StartTime"> <summary> The beginning of the time interval to retrieve events for, specified in ISO 8601 format. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsRequest.EndTime"> <summary> The end of the time interval for which to retrieve events, specified in ISO 8601 format. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsRequest.Duration"> <summary> The number of minutes' worth of events to retrieve. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeEventsResponse"> <summary> Returns information about the DescribeEventsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsResponse.DescribeEventsResult"> <summary> Gets and sets the DescribeEventsResult property. Represents the output of a DescribeEvents operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeEventsResult"> <summary> <para>Represents the output of a <i>DescribeEvents</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsResult.WithEvents(Amazon.ElastiCache.Model.Event[])"> <summary> Adds elements to the Events collection </summary> <param name="events">The values to add to the Events collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeEventsResult.WithEvents(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.Event})"> <summary> Adds elements to the Events collection </summary> <param name="events">The values to add to the Events collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeEventsResult.Events"> <summary> A list of events. Each element in the list contains detailed information about one event. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest"> <summary> Container for the parameters to the DescribeReplicationGroups operation. <para>The <i>DescribeReplicationGroups</i> operation returns information about a particular replication group. If no identifier is specified, <i>DescribeReplicationGroups</i> returns information about all replication groups.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReplicationGroups(Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest.WithReplicationGroupId(System.String)"> <summary> Sets the ReplicationGroupId property </summary> <param name="replicationGroupId">The value to set for the ReplicationGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest.ReplicationGroupId"> <summary> The identifier for the replication group to be described. This parameter is not case sensitive. If you do not specify this parameter, information about all replication groups is returned. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReplicationGroupsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReplicationGroupsResponse"> <summary> Returns information about the DescribeReplicationGroupsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReplicationGroupsResponse.DescribeReplicationGroupsResult"> <summary> Gets and sets the DescribeReplicationGroupsResult property. Represents the output of a DescribeReplicationGroups operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReplicationGroupsResult"> <summary> <para>Represents the output of a <i>DescribeReplicationGroups</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReplicationGroupsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReplicationGroupsResult.WithReplicationGroups(Amazon.ElastiCache.Model.ReplicationGroup[])"> <summary> Adds elements to the ReplicationGroups collection </summary> <param name="replicationGroups">The values to add to the ReplicationGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReplicationGroupsResult.WithReplicationGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.ReplicationGroup})"> <summary> Adds elements to the ReplicationGroups collection </summary> <param name="replicationGroups">The values to add to the ReplicationGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReplicationGroupsResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReplicationGroupsResult.ReplicationGroups"> <summary> A list of replication groups. Each item in the list contains detailed information about one replication group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest"> <summary> Container for the parameters to the DescribeReservedCacheNodesOfferings operation. <para>The <i>DescribeReservedCacheNodesOfferings</i> operation lists available reserved cache node offerings.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodesOfferings(Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.WithReservedCacheNodesOfferingId(System.String)"> <summary> Sets the ReservedCacheNodesOfferingId property </summary> <param name="reservedCacheNodesOfferingId">The value to set for the ReservedCacheNodesOfferingId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.WithDuration(System.String)"> <summary> Sets the Duration property </summary> <param name="duration">The value to set for the Duration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.WithProductDescription(System.String)"> <summary> Sets the ProductDescription property </summary> <param name="productDescription">The value to set for the ProductDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.WithOfferingType(System.String)"> <summary> Sets the OfferingType property </summary> <param name="offeringType">The value to set for the OfferingType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.ReservedCacheNodesOfferingId"> <summary> The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. Example: <c>438012d3-4052-4cc7-b2e3-8d3372e0e706</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.CacheNodeType"> <summary> The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.Duration"> <summary> Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration. Valid Values: <c>1 | 3 | 31536000 | 94608000</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.ProductDescription"> <summary> The product description filter value. Use this parameter to show only the available offerings matching the specified product description. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.OfferingType"> <summary> The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid Values: <c>"Light Utilization" | "Medium Utilization" | "Heavy Utilization" </c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResponse"> <summary> Returns information about the DescribeReservedCacheNodesOfferingsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResponse.DescribeReservedCacheNodesOfferingsResult"> <summary> Gets and sets the DescribeReservedCacheNodesOfferingsResult property. Represents the output of a DescribeReservedCacheNodesOfferings operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResult"> <summary> <para>Represents the output of a <i>DescribeReservedCacheNodesOfferings</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResult.WithReservedCacheNodesOfferings(Amazon.ElastiCache.Model.ReservedCacheNodesOffering[])"> <summary> Adds elements to the ReservedCacheNodesOfferings collection </summary> <param name="reservedCacheNodesOfferings">The values to add to the ReservedCacheNodesOfferings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResult.WithReservedCacheNodesOfferings(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.ReservedCacheNodesOffering})"> <summary> Adds elements to the ReservedCacheNodesOfferings collection </summary> <param name="reservedCacheNodesOfferings">The values to add to the ReservedCacheNodesOfferings collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesOfferingsResult.ReservedCacheNodesOfferings"> <summary> A list of reserved cache node offerings. Each element in the list contains detailed information about one offering. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest"> <summary> Container for the parameters to the DescribeReservedCacheNodes operation. <para>The <i>DescribeReservedCacheNodes</i> operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeReservedCacheNodes(Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithReservedCacheNodeId(System.String)"> <summary> Sets the ReservedCacheNodeId property </summary> <param name="reservedCacheNodeId">The value to set for the ReservedCacheNodeId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithReservedCacheNodesOfferingId(System.String)"> <summary> Sets the ReservedCacheNodesOfferingId property </summary> <param name="reservedCacheNodesOfferingId">The value to set for the ReservedCacheNodesOfferingId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithDuration(System.String)"> <summary> Sets the Duration property </summary> <param name="duration">The value to set for the Duration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithProductDescription(System.String)"> <summary> Sets the ProductDescription property </summary> <param name="productDescription">The value to set for the ProductDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithOfferingType(System.String)"> <summary> Sets the OfferingType property </summary> <param name="offeringType">The value to set for the OfferingType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.ReservedCacheNodeId"> <summary> The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.ReservedCacheNodesOfferingId"> <summary> The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.CacheNodeType"> <summary> The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.Duration"> <summary> The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration. Valid Values: <c>1 | 3 | 31536000 | 94608000</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.ProductDescription"> <summary> The product description filter value. Use this parameter to show only those reservations matching the specified product description. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.OfferingType"> <summary> The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: <c>"Light Utilization" | "Medium Utilization" | "Heavy Utilization" </c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 100Constraints: minimum 20; maximum 100. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResponse"> <summary> Returns information about the DescribeReservedCacheNodesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResponse.DescribeReservedCacheNodesResult"> <summary> Gets and sets the DescribeReservedCacheNodesResult property. Represents the output of a DescribeReservedCacheNodes operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResult"> <summary> <para>Represents the output of a <i>DescribeReservedCacheNodes</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResult.WithReservedCacheNodes(Amazon.ElastiCache.Model.ReservedCacheNode[])"> <summary> Adds elements to the ReservedCacheNodes collection </summary> <param name="reservedCacheNodes">The values to add to the ReservedCacheNodes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResult.WithReservedCacheNodes(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.ReservedCacheNode})"> <summary> Adds elements to the ReservedCacheNodes collection </summary> <param name="reservedCacheNodes">The values to add to the ReservedCacheNodes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResult.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeReservedCacheNodesResult.ReservedCacheNodes"> <summary> A list of reserved cache nodes. Each element in the list contains detailed information about one node. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeSnapshotsRequest"> <summary> Container for the parameters to the DescribeSnapshots operation. <para>The <i>DescribeSnapshots</i> operation 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.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.DescribeSnapshots(Amazon.ElastiCache.Model.DescribeSnapshotsRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.WithSnapshotName(System.String)"> <summary> Sets the SnapshotName property </summary> <param name="snapshotName">The value to set for the SnapshotName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.WithSnapshotSource(System.String)"> <summary> Sets the SnapshotSource property </summary> <param name="snapshotSource">The value to set for the SnapshotSource property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.CacheClusterId"> <summary> A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.SnapshotName"> <summary> A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.SnapshotSource"> <summary> Indicates whether the snapshot is from an automatic backup (<c>automated</c>) or was created manually (<c>manual</c>). </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsRequest.MaxRecords"> <summary> The maximum number of records to include in the response. If more records exist than the specified <c>MaxRecords</c> value, a marker is included in the response so that the remaining results can be retrieved. Default: 50Constraints: minimum 20; maximum 50. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeSnapshotsResponse"> <summary> Returns information about the DescribeSnapshotsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsResponse.DescribeSnapshotsResult"> <summary> Gets and sets the DescribeSnapshotsResult property. Represents the output of a DescribeSnapshots operation. </summary> </member> <member name="T:Amazon.ElastiCache.Model.DescribeSnapshotsResult"> <summary> <para>Represents the output of a <i>DescribeSnapshots</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsResult.WithSnapshots(Amazon.ElastiCache.Model.Snapshot[])"> <summary> Adds elements to the Snapshots collection </summary> <param name="snapshots">The values to add to the Snapshots collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.DescribeSnapshotsResult.WithSnapshots(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.Snapshot})"> <summary> Adds elements to the Snapshots collection </summary> <param name="snapshots">The values to add to the Snapshots collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsResult.Marker"> <summary> An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <i>MaxRecords</i>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.DescribeSnapshotsResult.Snapshots"> <summary> A list of snapshots. Each item in the list contains detailed information about one snapshot. </summary> </member> <member name="T:Amazon.ElastiCache.Model.EC2SecurityGroup"> <summary> <para>Provides ownership and status information for an Amazon EC2 security group.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.EC2SecurityGroup.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.EC2SecurityGroup.WithEC2SecurityGroupName(System.String)"> <summary> Sets the EC2SecurityGroupName property </summary> <param name="eC2SecurityGroupName">The value to set for the EC2SecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.EC2SecurityGroup.WithEC2SecurityGroupOwnerId(System.String)"> <summary> Sets the EC2SecurityGroupOwnerId property </summary> <param name="eC2SecurityGroupOwnerId">The value to set for the EC2SecurityGroupOwnerId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.EC2SecurityGroup.Status"> <summary> The status of the Amazon EC2 security group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.EC2SecurityGroup.EC2SecurityGroupName"> <summary> The name of the Amazon EC2 security group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.EC2SecurityGroup.EC2SecurityGroupOwnerId"> <summary> The AWS account ID of the Amazon EC2 security group owner. </summary> </member> <member name="T:Amazon.ElastiCache.Model.Endpoint"> <summary> <para>Represents the information required for client programs to connect to a cache node.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.Endpoint.WithAddress(System.String)"> <summary> Sets the Address property </summary> <param name="address">The value to set for the Address property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Endpoint.WithPort(System.Int32)"> <summary> Sets the Port property </summary> <param name="port">The value to set for the Port property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.Endpoint.Address"> <summary> The DNS hostname of the cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Endpoint.Port"> <summary> The port number that the cache engine is listening on. </summary> </member> <member name="T:Amazon.ElastiCache.Model.EngineDefaults"> <summary> <para>Represents the output of a <i>DescribeEngineDefaultParameters</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.EngineDefaults.WithCacheParameterGroupFamily(System.String)"> <summary> Sets the CacheParameterGroupFamily property </summary> <param name="cacheParameterGroupFamily">The value to set for the CacheParameterGroupFamily property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.EngineDefaults.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.EngineDefaults.WithParameters(Amazon.ElastiCache.Model.Parameter[])"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.EngineDefaults.WithParameters(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.Parameter})"> <summary> Adds elements to the Parameters collection </summary> <param name="parameters">The values to add to the Parameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.EngineDefaults.WithCacheNodeTypeSpecificParameters(Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter[])"> <summary> Adds elements to the CacheNodeTypeSpecificParameters collection </summary> <param name="cacheNodeTypeSpecificParameters">The values to add to the CacheNodeTypeSpecificParameters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.EngineDefaults.WithCacheNodeTypeSpecificParameters(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.CacheNodeTypeSpecificParameter})"> <summary> Adds elements to the CacheNodeTypeSpecificParameters collection </summary> <param name="cacheNodeTypeSpecificParameters">The values to add to the CacheNodeTypeSpecificParameters collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.EngineDefaults.CacheParameterGroupFamily"> <summary> Specifies the name of the cache parameter group family to which the engine default parameters apply. </summary> </member> <member name="P:Amazon.ElastiCache.Model.EngineDefaults.Marker"> <summary> Provides an identifier to allow retrieval of paginated results. </summary> </member> <member name="P:Amazon.ElastiCache.Model.EngineDefaults.Parameters"> <summary> Contains a list of engine default parameters. </summary> </member> <member name="P:Amazon.ElastiCache.Model.EngineDefaults.CacheNodeTypeSpecificParameters"> <summary> A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter. </summary> </member> <member name="T:Amazon.ElastiCache.Model.Event"> <summary> <para>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.Event.WithSourceIdentifier(System.String)"> <summary> Sets the SourceIdentifier property </summary> <param name="sourceIdentifier">The value to set for the SourceIdentifier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Event.WithSourceType(System.String)"> <summary> Sets the SourceType property </summary> <param name="sourceType">The value to set for the SourceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Event.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Event.WithDate(System.DateTime)"> <summary> Sets the Date property </summary> <param name="date">The value to set for the Date property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.Event.SourceIdentifier"> <summary> The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Event.SourceType"> <summary> Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.ElastiCache.Model.Event.Message"> <summary> The text of the event. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Event.Date"> <summary> The date and time when the event occurred. </summary> </member> <member name="T:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InsufficientCacheClusterCapacityException.#ctor(System.String)"> <summary> Constructs a new InsufficientCacheClusterCapacityException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.AuthorizeCacheSecurityGroupIngressRequestMarshaller"> <summary> Authorize Cache Security Group Ingress Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.AuthorizeCacheSecurityGroupIngressResponseUnmarshaller"> <summary> Response Unmarshaller for AuthorizeCacheSecurityGroupIngress operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.AuthorizeCacheSecurityGroupIngressResultUnmarshaller"> <summary> Result Unmarshaller for AuthorizeCacheSecurityGroupIngress operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.AvailabilityZoneUnmarshaller"> <summary> AvailabilityZone Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheClusterUnmarshaller"> <summary> CacheCluster Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheEngineVersionUnmarshaller"> <summary> CacheEngineVersion Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheNodeTypeSpecificParameterUnmarshaller"> <summary> CacheNodeTypeSpecificParameter Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheNodeTypeSpecificValueUnmarshaller"> <summary> CacheNodeTypeSpecificValue Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheNodeUnmarshaller"> <summary> CacheNode Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheParameterGroupStatusUnmarshaller"> <summary> CacheParameterGroupStatus Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheParameterGroupUnmarshaller"> <summary> CacheParameterGroup Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheSecurityGroupMembershipUnmarshaller"> <summary> CacheSecurityGroupMembership Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheSecurityGroupUnmarshaller"> <summary> CacheSecurityGroup Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CacheSubnetGroupUnmarshaller"> <summary> CacheSubnetGroup Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CopySnapshotRequestMarshaller"> <summary> Copy Snapshot Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CopySnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for CopySnapshot operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CopySnapshotResultUnmarshaller"> <summary> Result Unmarshaller for CopySnapshot operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheClusterRequestMarshaller"> <summary> Create Cache Cluster Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheClusterResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheClusterResultUnmarshaller"> <summary> Result Unmarshaller for CreateCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheParameterGroupRequestMarshaller"> <summary> Create Cache Parameter Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheParameterGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCacheParameterGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheParameterGroupResultUnmarshaller"> <summary> Result Unmarshaller for CreateCacheParameterGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheSecurityGroupRequestMarshaller"> <summary> Create Cache Security Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheSecurityGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCacheSecurityGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheSecurityGroupResultUnmarshaller"> <summary> Result Unmarshaller for CreateCacheSecurityGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheSubnetGroupRequestMarshaller"> <summary> Create Cache Subnet Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheSubnetGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCacheSubnetGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateCacheSubnetGroupResultUnmarshaller"> <summary> Result Unmarshaller for CreateCacheSubnetGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateReplicationGroupRequestMarshaller"> <summary> Create Replication Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateReplicationGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateReplicationGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateReplicationGroupResultUnmarshaller"> <summary> Result Unmarshaller for CreateReplicationGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateSnapshotRequestMarshaller"> <summary> Create Snapshot Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for CreateSnapshot operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.CreateSnapshotResultUnmarshaller"> <summary> Result Unmarshaller for CreateSnapshot operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheClusterRequestMarshaller"> <summary> Delete Cache Cluster Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheClusterResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheClusterResultUnmarshaller"> <summary> Result Unmarshaller for DeleteCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheParameterGroupRequestMarshaller"> <summary> Delete Cache Parameter Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheParameterGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteCacheParameterGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheSecurityGroupRequestMarshaller"> <summary> Delete Cache Security Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheSecurityGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteCacheSecurityGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheSubnetGroupRequestMarshaller"> <summary> Delete Cache Subnet Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteCacheSubnetGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteCacheSubnetGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteReplicationGroupRequestMarshaller"> <summary> Delete Replication Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteReplicationGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteReplicationGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteReplicationGroupResultUnmarshaller"> <summary> Result Unmarshaller for DeleteReplicationGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteSnapshotRequestMarshaller"> <summary> Delete Snapshot Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSnapshot operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DeleteSnapshotResultUnmarshaller"> <summary> Result Unmarshaller for DeleteSnapshot operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheClustersRequestMarshaller"> <summary> Describe Cache Clusters Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheClustersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCacheClusters operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheClustersResultUnmarshaller"> <summary> DescribeCacheClustersResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheEngineVersionsRequestMarshaller"> <summary> Describe Cache Engine Versions Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheEngineVersionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCacheEngineVersions operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheEngineVersionsResultUnmarshaller"> <summary> DescribeCacheEngineVersionsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheParameterGroupsRequestMarshaller"> <summary> Describe Cache Parameter Groups Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheParameterGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCacheParameterGroups operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheParameterGroupsResultUnmarshaller"> <summary> DescribeCacheParameterGroupsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheParametersRequestMarshaller"> <summary> Describe Cache Parameters Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheParametersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCacheParameters operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheParametersResultUnmarshaller"> <summary> DescribeCacheParametersResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheSecurityGroupsRequestMarshaller"> <summary> Describe Cache Security Groups Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheSecurityGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCacheSecurityGroups operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheSecurityGroupsResultUnmarshaller"> <summary> DescribeCacheSecurityGroupsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheSubnetGroupsRequestMarshaller"> <summary> Describe Cache Subnet Groups Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheSubnetGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCacheSubnetGroups operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeCacheSubnetGroupsResultUnmarshaller"> <summary> DescribeCacheSubnetGroupsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeEngineDefaultParametersRequestMarshaller"> <summary> Describe Engine Default Parameters Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeEngineDefaultParametersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeEngineDefaultParameters operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeEngineDefaultParametersResultUnmarshaller"> <summary> Result Unmarshaller for DescribeEngineDefaultParameters operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeEventsRequestMarshaller"> <summary> Describe Events Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeEventsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeEvents operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeEventsResultUnmarshaller"> <summary> DescribeEventsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReplicationGroupsRequestMarshaller"> <summary> Describe Replication Groups Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReplicationGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeReplicationGroups operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReplicationGroupsResultUnmarshaller"> <summary> DescribeReplicationGroupsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReservedCacheNodesOfferingsRequestMarshaller"> <summary> Describe Reserved Cache Nodes Offerings Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReservedCacheNodesOfferingsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeReservedCacheNodesOfferings operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReservedCacheNodesOfferingsResultUnmarshaller"> <summary> DescribeReservedCacheNodesOfferingsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReservedCacheNodesRequestMarshaller"> <summary> Describe Reserved Cache Nodes Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReservedCacheNodesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeReservedCacheNodes operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeReservedCacheNodesResultUnmarshaller"> <summary> DescribeReservedCacheNodesResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeSnapshotsRequestMarshaller"> <summary> Describe Snapshots Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeSnapshotsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSnapshots operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.DescribeSnapshotsResultUnmarshaller"> <summary> DescribeSnapshotsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.EC2SecurityGroupUnmarshaller"> <summary> EC2SecurityGroup Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.EndpointUnmarshaller"> <summary> Endpoint Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.EngineDefaultsUnmarshaller"> <summary> EngineDefaults Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.EventUnmarshaller"> <summary> Event Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheClusterRequestMarshaller"> <summary> Modify Cache Cluster Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheClusterResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheClusterResultUnmarshaller"> <summary> Result Unmarshaller for ModifyCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheParameterGroupRequestMarshaller"> <summary> Modify Cache Parameter Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheParameterGroupResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyCacheParameterGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheParameterGroupResultUnmarshaller"> <summary> ModifyCacheParameterGroupResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheSubnetGroupRequestMarshaller"> <summary> Modify Cache Subnet Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheSubnetGroupResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyCacheSubnetGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyCacheSubnetGroupResultUnmarshaller"> <summary> Result Unmarshaller for ModifyCacheSubnetGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyReplicationGroupRequestMarshaller"> <summary> Modify Replication Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyReplicationGroupResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyReplicationGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ModifyReplicationGroupResultUnmarshaller"> <summary> Result Unmarshaller for ModifyReplicationGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.NodeGroupMemberUnmarshaller"> <summary> NodeGroupMember Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.NodeGroupUnmarshaller"> <summary> NodeGroup Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.NodeSnapshotUnmarshaller"> <summary> NodeSnapshot Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.NotificationConfigurationUnmarshaller"> <summary> NotificationConfiguration Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ParameterUnmarshaller"> <summary> Parameter Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.PendingModifiedValuesUnmarshaller"> <summary> PendingModifiedValues Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.PurchaseReservedCacheNodesOfferingRequestMarshaller"> <summary> Purchase Reserved Cache Nodes Offering Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.PurchaseReservedCacheNodesOfferingResponseUnmarshaller"> <summary> Response Unmarshaller for PurchaseReservedCacheNodesOffering operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.PurchaseReservedCacheNodesOfferingResultUnmarshaller"> <summary> Result Unmarshaller for PurchaseReservedCacheNodesOffering operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.RebootCacheClusterRequestMarshaller"> <summary> Reboot Cache Cluster Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.RebootCacheClusterResponseUnmarshaller"> <summary> Response Unmarshaller for RebootCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.RebootCacheClusterResultUnmarshaller"> <summary> Result Unmarshaller for RebootCacheCluster operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.RecurringChargeUnmarshaller"> <summary> RecurringCharge Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ReplicationGroupPendingModifiedValuesUnmarshaller"> <summary> ReplicationGroupPendingModifiedValues Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ReplicationGroupUnmarshaller"> <summary> ReplicationGroup Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ReservedCacheNodesOfferingUnmarshaller"> <summary> ReservedCacheNodesOffering Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ReservedCacheNodeUnmarshaller"> <summary> ReservedCacheNode Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ResetCacheParameterGroupRequestMarshaller"> <summary> Reset Cache Parameter Group Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ResetCacheParameterGroupResponseUnmarshaller"> <summary> Response Unmarshaller for ResetCacheParameterGroup operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.ResetCacheParameterGroupResultUnmarshaller"> <summary> ResetCacheParameterGroupResult Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.RevokeCacheSecurityGroupIngressRequestMarshaller"> <summary> Revoke Cache Security Group Ingress Request Marshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.RevokeCacheSecurityGroupIngressResponseUnmarshaller"> <summary> Response Unmarshaller for RevokeCacheSecurityGroupIngress operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.RevokeCacheSecurityGroupIngressResultUnmarshaller"> <summary> Result Unmarshaller for RevokeCacheSecurityGroupIngress operation </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.SecurityGroupMembershipUnmarshaller"> <summary> SecurityGroupMembership Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.SnapshotUnmarshaller"> <summary> Snapshot Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.Internal.MarshallTransformations.SubnetUnmarshaller"> <summary> Subnet Unmarshaller </summary> </member> <member name="T:Amazon.ElastiCache.Model.InvalidCacheClusterStateException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidCacheClusterStateException.#ctor(System.String)"> <summary> Constructs a new InvalidCacheClusterStateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidCacheParameterGroupStateException.#ctor(System.String)"> <summary> Constructs a new InvalidCacheParameterGroupStateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidCacheSecurityGroupStateException.#ctor(System.String)"> <summary> Constructs a new InvalidCacheSecurityGroupStateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidParameterCombinationException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidParameterCombinationException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterCombinationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidParameterValueException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidParameterValueException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterValueException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidReplicationGroupStateException.#ctor(System.String)"> <summary> Constructs a new InvalidReplicationGroupStateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidSnapshotStateException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidSnapshotStateException.#ctor(System.String)"> <summary> Constructs a new InvalidSnapshotStateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidSubnetException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidSubnetException.#ctor(System.String)"> <summary> Constructs a new InvalidSubnetException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.InvalidVPCNetworkStateException.#ctor(System.String)"> <summary> Constructs a new InvalidVPCNetworkStateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheClusterRequest"> <summary> Container for the parameters to the ModifyCacheCluster operation. <para>The <i>ModifyCacheCluster</i> operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheCluster(Amazon.ElastiCache.Model.ModifyCacheClusterRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithNumCacheNodes(System.Int32)"> <summary> Sets the NumCacheNodes property </summary> <param name="numCacheNodes">The value to set for the NumCacheNodes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithCacheNodeIdsToRemove(System.String[])"> <summary> Adds elements to the CacheNodeIdsToRemove collection </summary> <param name="cacheNodeIdsToRemove">The values to add to the CacheNodeIdsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithCacheNodeIdsToRemove(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CacheNodeIdsToRemove collection </summary> <param name="cacheNodeIdsToRemove">The values to add to the CacheNodeIdsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithCacheSecurityGroupNames(System.String[])"> <summary> Adds elements to the CacheSecurityGroupNames collection </summary> <param name="cacheSecurityGroupNames">The values to add to the CacheSecurityGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithCacheSecurityGroupNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CacheSecurityGroupNames collection </summary> <param name="cacheSecurityGroupNames">The values to add to the CacheSecurityGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithSecurityGroupIds(System.String[])"> <summary> Adds elements to the SecurityGroupIds collection </summary> <param name="securityGroupIds">The values to add to the SecurityGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithSecurityGroupIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SecurityGroupIds collection </summary> <param name="securityGroupIds">The values to add to the SecurityGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithPreferredMaintenanceWindow(System.String)"> <summary> Sets the PreferredMaintenanceWindow property </summary> <param name="preferredMaintenanceWindow">The value to set for the PreferredMaintenanceWindow property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithNotificationTopicArn(System.String)"> <summary> Sets the NotificationTopicArn property </summary> <param name="notificationTopicArn">The value to set for the NotificationTopicArn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithNotificationTopicStatus(System.String)"> <summary> Sets the NotificationTopicStatus property </summary> <param name="notificationTopicStatus">The value to set for the NotificationTopicStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithApplyImmediately(System.Boolean)"> <summary> Sets the ApplyImmediately property </summary> <param name="applyImmediately">The value to set for the ApplyImmediately property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithAutoMinorVersionUpgrade(System.Boolean)"> <summary> Sets the AutoMinorVersionUpgrade property </summary> <param name="autoMinorVersionUpgrade">The value to set for the AutoMinorVersionUpgrade property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithSnapshotRetentionLimit(System.Int32)"> <summary> Sets the SnapshotRetentionLimit property </summary> <param name="snapshotRetentionLimit">The value to set for the SnapshotRetentionLimit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.WithSnapshotWindow(System.String)"> <summary> Sets the SnapshotWindow property </summary> <param name="snapshotWindow">The value to set for the SnapshotWindow property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.CacheClusterId"> <summary> The cache cluster identifier. This value is stored as a lowercase string. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.NumCacheNodes"> <summary> The number of cache nodes that the cache cluster should have. If the value for <i>NumCacheNodes</i> is greater than the existing number of cache nodes, then more nodes will be added. If the value is less than the existing number of cache nodes, then cache nodes will be removed. If you are removing cache nodes, you must use the <i>CacheNodeIdsToRemove</i> parameter to provide the IDs of the specific cache nodes to be removed. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.CacheNodeIdsToRemove"> <summary> A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster and the value of <i>NumCacheNodes</i> in the request. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.CacheSecurityGroupNames"> <summary> A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible. This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default". </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.SecurityGroupIds"> <summary> Specifies the VPC Security Groups associated with the cache cluster. This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC). </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.PreferredMaintenanceWindow"> <summary> The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.NotificationTopicArn"> <summary> The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. <note> The SNS topic owner must be same as the cache cluster owner. </note> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.CacheParameterGroupName"> <summary> The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the <i>ApplyImmediately</i> parameter is specified as <i>true</i> for this request. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.NotificationTopicStatus"> <summary> The status of the Amazon SNS notification topic. Notifications are sent only if the status is <i>active</i>. Valid values: <c>active</c> | <c>inactive</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.ApplyImmediately"> <summary> If <c>true</c>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <i>PreferredMaintenanceWindow</i> setting for the cache cluster. If <c>false</c>, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: <c>true</c> | <c>false</c> Default: <c>false</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.EngineVersion"> <summary> The upgraded version of the cache engine to be run on the cache cluster nodes. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.AutoMinorVersionUpgrade"> <summary> If <c>true</c>, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. Valid values: <c>true</c> | <c>false</c> Default: <c>true</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.SnapshotRetentionLimit"> <summary> The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterRequest.SnapshotWindow"> <summary> The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheClusterResponse"> <summary> Returns information about the ModifyCacheCluster response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterResponse.ModifyCacheClusterResult"> Gets and sets the ModifyCacheClusterResult property. Contains the result of a successful invocation of the ModifyCacheCluster action. </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheClusterResult"> <summary> The results from the ModifyCacheCluster action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheClusterResult.CacheCluster"> <summary> Gets and sets the ModifyCacheClusterResult property. Contains the result of a successful invocation of the ModifyCacheCluster action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest"> <summary> Container for the parameters to the ModifyCacheParameterGroup operation. <para>The <i>ModifyCacheParameterGroup</i> operation 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.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheParameterGroup(Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest.WithParameterNameValues(Amazon.ElastiCache.Model.ParameterNameValue[])"> <summary> Adds elements to the ParameterNameValues collection </summary> <param name="parameterNameValues">The values to add to the ParameterNameValues collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest.WithParameterNameValues(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.ParameterNameValue})"> <summary> Adds elements to the ParameterNameValues collection </summary> <param name="parameterNameValues">The values to add to the ParameterNameValues collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest.CacheParameterGroupName"> <summary> The name of the cache parameter group to modify. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheParameterGroupRequest.ParameterNameValues"> <summary> An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheParameterGroupResponse"> <summary> Returns information about the ModifyCacheParameterGroupResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheParameterGroupResponse.ModifyCacheParameterGroupResult"> <summary> Gets and sets the ModifyCacheParameterGroupResult property. Represents the output of one of the following operations: ModifyCacheParameterGroup ResetCacheParameterGroup </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheParameterGroupResult"> <summary> <para>Represents the output of one of the following operations:</para> <ul> <li> <i>ModifyCacheParameterGroup</i> </li> <li> <i>ResetCacheParameterGroup</i> </li> </ul> </summary> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheParameterGroupResult.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheParameterGroupResult.CacheParameterGroupName"> <summary> The name of the cache parameter group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest"> <summary> Container for the parameters to the ModifyCacheSubnetGroup operation. <para>The <i>ModifyCacheSubnetGroup</i> operation modifies an existing cache subnet group.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyCacheSubnetGroup(Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest.WithCacheSubnetGroupDescription(System.String)"> <summary> Sets the CacheSubnetGroupDescription property </summary> <param name="cacheSubnetGroupDescription">The value to set for the CacheSubnetGroupDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest.WithSubnetIds(System.String[])"> <summary> Adds elements to the SubnetIds collection </summary> <param name="subnetIds">The values to add to the SubnetIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest.WithSubnetIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SubnetIds collection </summary> <param name="subnetIds">The values to add to the SubnetIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest.CacheSubnetGroupName"> <summary> The name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: <c>mysubnetgroup</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest.CacheSubnetGroupDescription"> <summary> A description for the cache subnet group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupRequest.SubnetIds"> <summary> The EC2 subnet IDs for the cache subnet group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupResponse"> <summary> Returns information about the ModifyCacheSubnetGroup response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupResponse.ModifyCacheSubnetGroupResult"> Gets and sets the ModifyCacheSubnetGroupResult property. Contains the result of a successful invocation of the ModifyCacheSubnetGroup action. </member> <member name="T:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupResult"> <summary> The results from the ModifyCacheSubnetGroup action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyCacheSubnetGroupResult.CacheSubnetGroup"> <summary> Gets and sets the ModifyCacheSubnetGroupResult property. Contains the result of a successful invocation of the ModifyCacheSubnetGroup action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest"> <summary> Container for the parameters to the ModifyReplicationGroup operation. <para>The <i>ModifyReplicationGroup</i> operation modifies the settings for a replication group.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ModifyReplicationGroup(Amazon.ElastiCache.Model.ModifyReplicationGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithReplicationGroupId(System.String)"> <summary> Sets the ReplicationGroupId property </summary> <param name="replicationGroupId">The value to set for the ReplicationGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithReplicationGroupDescription(System.String)"> <summary> Sets the ReplicationGroupDescription property </summary> <param name="replicationGroupDescription">The value to set for the ReplicationGroupDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithCacheSecurityGroupNames(System.String[])"> <summary> Adds elements to the CacheSecurityGroupNames collection </summary> <param name="cacheSecurityGroupNames">The values to add to the CacheSecurityGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithCacheSecurityGroupNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CacheSecurityGroupNames collection </summary> <param name="cacheSecurityGroupNames">The values to add to the CacheSecurityGroupNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithSecurityGroupIds(System.String[])"> <summary> Adds elements to the SecurityGroupIds collection </summary> <param name="securityGroupIds">The values to add to the SecurityGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithSecurityGroupIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SecurityGroupIds collection </summary> <param name="securityGroupIds">The values to add to the SecurityGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithPreferredMaintenanceWindow(System.String)"> <summary> Sets the PreferredMaintenanceWindow property </summary> <param name="preferredMaintenanceWindow">The value to set for the PreferredMaintenanceWindow property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithNotificationTopicArn(System.String)"> <summary> Sets the NotificationTopicArn property </summary> <param name="notificationTopicArn">The value to set for the NotificationTopicArn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithNotificationTopicStatus(System.String)"> <summary> Sets the NotificationTopicStatus property </summary> <param name="notificationTopicStatus">The value to set for the NotificationTopicStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithApplyImmediately(System.Boolean)"> <summary> Sets the ApplyImmediately property </summary> <param name="applyImmediately">The value to set for the ApplyImmediately property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithAutoMinorVersionUpgrade(System.Boolean)"> <summary> Sets the AutoMinorVersionUpgrade property </summary> <param name="autoMinorVersionUpgrade">The value to set for the AutoMinorVersionUpgrade property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithPrimaryClusterId(System.String)"> <summary> Sets the PrimaryClusterId property </summary> <param name="primaryClusterId">The value to set for the PrimaryClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithSnapshotRetentionLimit(System.Int32)"> <summary> Sets the SnapshotRetentionLimit property </summary> <param name="snapshotRetentionLimit">The value to set for the SnapshotRetentionLimit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithSnapshotWindow(System.String)"> <summary> Sets the SnapshotWindow property </summary> <param name="snapshotWindow">The value to set for the SnapshotWindow property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.WithSnapshottingClusterId(System.String)"> <summary> Sets the SnapshottingClusterId property </summary> <param name="snapshottingClusterId">The value to set for the SnapshottingClusterId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.ReplicationGroupId"> <summary> The identifier of the replication group to modify. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.ReplicationGroupDescription"> <summary> A description for the replication group. Maximum length is 255 characters. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.CacheSecurityGroupNames"> <summary> A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible. This parameter can be used only with replication groups containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default". </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.SecurityGroupIds"> <summary> Specifies the VPC Security Groups associated with the cache clusters in the replication group. This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC). </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.PreferredMaintenanceWindow"> <summary> The weekly time range (in UTC) during which replication group system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.NotificationTopicArn"> <summary> The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. <note> The SNS topic owner must be same as the replication group owner. </note> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.CacheParameterGroupName"> <summary> The name of the cache parameter group to apply to all of the cache nodes in this replication group. This change is asynchronously applied as soon as possible for parameters when the <i>ApplyImmediately</i> parameter is specified as <i>true</i> for this request. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.NotificationTopicStatus"> <summary> The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is <i>active</i>. Valid values: <c>active</c> | <c>inactive</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.ApplyImmediately"> <summary> If <c>true</c>, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the <i>PreferredMaintenanceWindow</i> setting for the replication group. If <c>false</c>, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: <c>true</c> | <c>false</c> Default: <c>false</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.EngineVersion"> <summary> The upgraded version of the cache engine to be run on the nodes in the replication group.. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.AutoMinorVersionUpgrade"> <summary> Determines whether minor engine upgrades will be applied automatically to all of the cache nodes in the replication group during the maintenance window. A value of <c>true</c> allows these upgrades to occur; <c>false</c> disables automatic upgrades. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.PrimaryClusterId"> <summary> If this parameter is specified, ElastiCache will promote each of the nodes in the specified cache cluster to the primary role. The nodes of all other clusters in the replication group will be read replicas. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.SnapshotRetentionLimit"> <summary> The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set <i>SnapshotRetentionLimit</i> to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.SnapshotWindow"> <summary> asdfasdf The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster specified by <i>SnapshottingClusterId</i>. Example: <c>05:00-09:00</c> If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupRequest.SnapshottingClusterId"> <summary> The cache cluster ID that will be used as the daily snapshot source for the replication group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ModifyReplicationGroupResponse"> <summary> Returns information about the ModifyReplicationGroup response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupResponse.ModifyReplicationGroupResult"> Gets and sets the ModifyReplicationGroupResult property. Contains the result of a successful invocation of the ModifyReplicationGroup action. </member> <member name="T:Amazon.ElastiCache.Model.ModifyReplicationGroupResult"> <summary> The results from the ModifyReplicationGroup action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ModifyReplicationGroupResult.ReplicationGroup"> <summary> Gets and sets the ModifyReplicationGroupResult property. Contains the result of a successful invocation of the ModifyReplicationGroup action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.NodeGroup"> <summary> <para>Represents a collection of cache nodes in a replication group.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroup.WithNodeGroupId(System.String)"> <summary> Sets the NodeGroupId property </summary> <param name="nodeGroupId">The value to set for the NodeGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroup.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroup.WithPrimaryEndpoint(Amazon.ElastiCache.Model.Endpoint)"> <summary> Sets the PrimaryEndpoint property </summary> <param name="primaryEndpoint">The value to set for the PrimaryEndpoint property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroup.WithNodeGroupMembers(Amazon.ElastiCache.Model.NodeGroupMember[])"> <summary> Adds elements to the NodeGroupMembers collection </summary> <param name="nodeGroupMembers">The values to add to the NodeGroupMembers collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroup.WithNodeGroupMembers(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.NodeGroupMember})"> <summary> Adds elements to the NodeGroupMembers collection </summary> <param name="nodeGroupMembers">The values to add to the NodeGroupMembers collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroup.NodeGroupId"> <summary> The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroup.Status"> <summary> The current state of this replication group - <i>creating</i>, <i>available</i>, etc. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroup.PrimaryEndpoint"> <summary> Represents the information required for client programs to connect to a cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroup.NodeGroupMembers"> <summary> A list containing information about individual nodes within the node group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.NodeGroupMember"> <summary> <para>Represents a single node within a node group.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroupMember.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroupMember.WithCacheNodeId(System.String)"> <summary> Sets the CacheNodeId property </summary> <param name="cacheNodeId">The value to set for the CacheNodeId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroupMember.WithReadEndpoint(Amazon.ElastiCache.Model.Endpoint)"> <summary> Sets the ReadEndpoint property </summary> <param name="readEndpoint">The value to set for the ReadEndpoint property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroupMember.WithPreferredAvailabilityZone(System.String)"> <summary> Sets the PreferredAvailabilityZone property </summary> <param name="preferredAvailabilityZone">The value to set for the PreferredAvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeGroupMember.WithCurrentRole(System.String)"> <summary> Sets the CurrentRole property </summary> <param name="currentRole">The value to set for the CurrentRole property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroupMember.CacheClusterId"> <summary> The ID of the cache cluster to which the node belongs. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroupMember.CacheNodeId"> <summary> The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.). </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroupMember.ReadEndpoint"> <summary> Represents the information required for client programs to connect to a cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroupMember.PreferredAvailabilityZone"> <summary> The name of the Availability Zone in which the node is located. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeGroupMember.CurrentRole"> <summary> The role that is currently assigned to the node - <i>primary</i> or <i>replica</i>. </summary> </member> <member name="T:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.NodeQuotaForClusterExceededException.#ctor(System.String)"> <summary> Constructs a new NodeQuotaForClusterExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.NodeQuotaForCustomerExceededException.#ctor(System.String)"> <summary> Constructs a new NodeQuotaForCustomerExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.NodeSnapshot"> <summary> <para>Represents an individual cache node in a snapshot of a cache cluster.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.NodeSnapshot.WithCacheNodeId(System.String)"> <summary> Sets the CacheNodeId property </summary> <param name="cacheNodeId">The value to set for the CacheNodeId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeSnapshot.WithCacheSize(System.String)"> <summary> Sets the CacheSize property </summary> <param name="cacheSize">The value to set for the CacheSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeSnapshot.WithCacheNodeCreateTime(System.DateTime)"> <summary> Sets the CacheNodeCreateTime property </summary> <param name="cacheNodeCreateTime">The value to set for the CacheNodeCreateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NodeSnapshot.WithSnapshotCreateTime(System.DateTime)"> <summary> Sets the SnapshotCreateTime property </summary> <param name="snapshotCreateTime">The value to set for the SnapshotCreateTime property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.NodeSnapshot.CacheNodeId"> <summary> The cache node identifier for the node in the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeSnapshot.CacheSize"> <summary> The size of the cache on the source cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeSnapshot.CacheNodeCreateTime"> <summary> The date and time when the cache node was created in the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NodeSnapshot.SnapshotCreateTime"> <summary> The date and time when the source node's metadata and cache data set was obtained for the snapshot. </summary> </member> <member name="T:Amazon.ElastiCache.Model.NotificationConfiguration"> <summary> <para>Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.NotificationConfiguration.WithTopicArn(System.String)"> <summary> Sets the TopicArn property </summary> <param name="topicArn">The value to set for the TopicArn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.NotificationConfiguration.WithTopicStatus(System.String)"> <summary> Sets the TopicStatus property </summary> <param name="topicStatus">The value to set for the TopicStatus property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.NotificationConfiguration.TopicArn"> <summary> The Amazon Resource Name (ARN) that identifies the topic. </summary> </member> <member name="P:Amazon.ElastiCache.Model.NotificationConfiguration.TopicStatus"> <summary> The current state of the topic. </summary> </member> <member name="T:Amazon.ElastiCache.Model.Parameter"> <summary> <para>Describes an individual setting that controls some aspect of ElastiCache behavior.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithParameterName(System.String)"> <summary> Sets the ParameterName property </summary> <param name="parameterName">The value to set for the ParameterName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithParameterValue(System.String)"> <summary> Sets the ParameterValue property </summary> <param name="parameterValue">The value to set for the ParameterValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithSource(System.String)"> <summary> Sets the Source property </summary> <param name="source">The value to set for the Source property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithDataType(System.String)"> <summary> Sets the DataType property </summary> <param name="dataType">The value to set for the DataType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithAllowedValues(System.String)"> <summary> Sets the AllowedValues property </summary> <param name="allowedValues">The value to set for the AllowedValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithIsModifiable(System.Boolean)"> <summary> Sets the IsModifiable property </summary> <param name="isModifiable">The value to set for the IsModifiable property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Parameter.WithMinimumEngineVersion(System.String)"> <summary> Sets the MinimumEngineVersion property </summary> <param name="minimumEngineVersion">The value to set for the MinimumEngineVersion property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.ParameterName"> <summary> The name of the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.ParameterValue"> <summary> The value of the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.Description"> <summary> A description of the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.Source"> <summary> The source of the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.DataType"> <summary> The valid data type for the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.AllowedValues"> <summary> The valid range of values for the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.IsModifiable"> <summary> Indicates whether (<c>true</c>) or not (<c>false</c>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Parameter.MinimumEngineVersion"> <summary> The earliest cache engine version to which the parameter can apply. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ParameterNameValue"> <summary> <para>Describes a name-value pair that is used to update the value of a parameter.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.ParameterNameValue.WithParameterName(System.String)"> <summary> Sets the ParameterName property </summary> <param name="parameterName">The value to set for the ParameterName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ParameterNameValue.WithParameterValue(System.String)"> <summary> Sets the ParameterValue property </summary> <param name="parameterValue">The value to set for the ParameterValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ParameterNameValue.ParameterName"> <summary> The name of the parameter. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ParameterNameValue.ParameterValue"> <summary> The value of the parameter. </summary> </member> <member name="T:Amazon.ElastiCache.Model.PendingModifiedValues"> <summary> <para>A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.PendingModifiedValues.WithNumCacheNodes(System.Int32)"> <summary> Sets the NumCacheNodes property </summary> <param name="numCacheNodes">The value to set for the NumCacheNodes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.PendingModifiedValues.WithCacheNodeIdsToRemove(System.String[])"> <summary> Adds elements to the CacheNodeIdsToRemove collection </summary> <param name="cacheNodeIdsToRemove">The values to add to the CacheNodeIdsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.PendingModifiedValues.WithCacheNodeIdsToRemove(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CacheNodeIdsToRemove collection </summary> <param name="cacheNodeIdsToRemove">The values to add to the CacheNodeIdsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.PendingModifiedValues.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.PendingModifiedValues.NumCacheNodes"> <summary> The new number of cache nodes for the cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.PendingModifiedValues.CacheNodeIdsToRemove"> <summary> A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.). </summary> </member> <member name="P:Amazon.ElastiCache.Model.PendingModifiedValues.EngineVersion"> <summary> The new cache engine version that the cache cluster will run. </summary> </member> <member name="T:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest"> <summary> Container for the parameters to the PurchaseReservedCacheNodesOffering operation. <para>The <i>PurchaseReservedCacheNodesOffering</i> operation allows you to purchase a reserved cache node offering.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.PurchaseReservedCacheNodesOffering(Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest.WithReservedCacheNodesOfferingId(System.String)"> <summary> Sets the ReservedCacheNodesOfferingId property </summary> <param name="reservedCacheNodesOfferingId">The value to set for the ReservedCacheNodesOfferingId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest.WithReservedCacheNodeId(System.String)"> <summary> Sets the ReservedCacheNodeId property </summary> <param name="reservedCacheNodeId">The value to set for the ReservedCacheNodeId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest.WithCacheNodeCount(System.Int32)"> <summary> Sets the CacheNodeCount property </summary> <param name="cacheNodeCount">The value to set for the CacheNodeCount property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest.ReservedCacheNodesOfferingId"> <summary> The ID of the reserved cache node offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 </summary> </member> <member name="P:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest.ReservedCacheNodeId"> <summary> A customer-specified identifier to track this reservation. Example: myreservationID </summary> </member> <member name="P:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingRequest.CacheNodeCount"> <summary> The number of cache node instances to reserve. Default: <c>1</c> </summary> </member> <member name="T:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingResponse"> <summary> Returns information about the PurchaseReservedCacheNodesOffering response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingResponse.PurchaseReservedCacheNodesOfferingResult"> Gets and sets the PurchaseReservedCacheNodesOfferingResult property. Contains the result of a successful invocation of the PurchaseReservedCacheNodesOffering action. </member> <member name="T:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingResult"> <summary> The results from the PurchaseReservedCacheNodesOffering action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.PurchaseReservedCacheNodesOfferingResult.ReservedCacheNode"> <summary> Gets and sets the PurchaseReservedCacheNodesOfferingResult property. Contains the result of a successful invocation of the PurchaseReservedCacheNodesOffering action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.RebootCacheClusterRequest"> <summary> Container for the parameters to the RebootCacheCluster operation. <para>The <i>RebootCacheCluster</i> operation reboots some, or all, of the cache cluster 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> <para>The reboot causes the contents of the cache (for each cache cluster node being rebooted) to be lost.</para> <para>When the reboot is complete, a cache cluster event is created.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RebootCacheCluster(Amazon.ElastiCache.Model.RebootCacheClusterRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.RebootCacheClusterRequest.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.RebootCacheClusterRequest.WithCacheNodeIdsToReboot(System.String[])"> <summary> Adds elements to the CacheNodeIdsToReboot collection </summary> <param name="cacheNodeIdsToReboot">The values to add to the CacheNodeIdsToReboot collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.RebootCacheClusterRequest.WithCacheNodeIdsToReboot(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the CacheNodeIdsToReboot collection </summary> <param name="cacheNodeIdsToReboot">The values to add to the CacheNodeIdsToReboot collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.RebootCacheClusterRequest.CacheClusterId"> <summary> The cache cluster identifier. This parameter is stored as a lowercase string. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RebootCacheClusterRequest.CacheNodeIdsToReboot"> <summary> A list of cache cluster node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache cluster node IDs. </summary> </member> <member name="T:Amazon.ElastiCache.Model.RebootCacheClusterResponse"> <summary> Returns information about the RebootCacheCluster response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RebootCacheClusterResponse.RebootCacheClusterResult"> Gets and sets the RebootCacheClusterResult property. Contains the result of a successful invocation of the RebootCacheCluster action. </member> <member name="T:Amazon.ElastiCache.Model.RebootCacheClusterResult"> <summary> The results from the RebootCacheCluster action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RebootCacheClusterResult.CacheCluster"> <summary> Gets and sets the RebootCacheClusterResult property. Contains the result of a successful invocation of the RebootCacheCluster action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.RecurringCharge"> <summary> <para>Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.RecurringCharge.WithRecurringChargeAmount(System.Double)"> <summary> Sets the RecurringChargeAmount property </summary> <param name="recurringChargeAmount">The value to set for the RecurringChargeAmount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.RecurringCharge.WithRecurringChargeFrequency(System.String)"> <summary> Sets the RecurringChargeFrequency property </summary> <param name="recurringChargeFrequency">The value to set for the RecurringChargeFrequency property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.RecurringCharge.RecurringChargeAmount"> <summary> The monetary amount of the recurring charge. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RecurringCharge.RecurringChargeFrequency"> <summary> The frequency of the recurring charge. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ReplicationGroup"> <summary> <para>Contains all of the attributes of a specific replication group.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithReplicationGroupId(System.String)"> <summary> Sets the ReplicationGroupId property </summary> <param name="replicationGroupId">The value to set for the ReplicationGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithPendingModifiedValues(Amazon.ElastiCache.Model.ReplicationGroupPendingModifiedValues)"> <summary> Sets the PendingModifiedValues property </summary> <param name="pendingModifiedValues">The value to set for the PendingModifiedValues property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithMemberClusters(System.String[])"> <summary> Adds elements to the MemberClusters collection </summary> <param name="memberClusters">The values to add to the MemberClusters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithMemberClusters(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the MemberClusters collection </summary> <param name="memberClusters">The values to add to the MemberClusters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithNodeGroups(Amazon.ElastiCache.Model.NodeGroup[])"> <summary> Adds elements to the NodeGroups collection </summary> <param name="nodeGroups">The values to add to the NodeGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithNodeGroups(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.NodeGroup})"> <summary> Adds elements to the NodeGroups collection </summary> <param name="nodeGroups">The values to add to the NodeGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroup.WithSnapshottingClusterId(System.String)"> <summary> Sets the SnapshottingClusterId property </summary> <param name="snapshottingClusterId">The value to set for the SnapshottingClusterId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroup.ReplicationGroupId"> <summary> The identifier for the replication group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroup.Description"> <summary> The description of the replication group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroup.Status"> <summary> The current state of this replication group - <i>creating</i>, <i>available</i>, etc. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroup.PendingModifiedValues"> <summary> A group of settings to be applied to the replication group, either immediately or during the next maintenance window. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroup.MemberClusters"> <summary> The names of all the cache clusters that are part of this replication group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroup.NodeGroups"> <summary> A single element list with information about the nodes in the replication group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroup.SnapshottingClusterId"> <summary> The cache cluster ID that is used as the daily snapshot source for the replication group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ReplicationGroupAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroupAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new ReplicationGroupAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroupNotFoundException.#ctor(System.String)"> <summary> Constructs a new ReplicationGroupNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ReplicationGroupPendingModifiedValues"> <summary> <para>The settings to be applied to the replication group, either immediately or during the next maintenance window.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReplicationGroupPendingModifiedValues.WithPrimaryClusterId(System.String)"> <summary> Sets the PrimaryClusterId property </summary> <param name="primaryClusterId">The value to set for the PrimaryClusterId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ReplicationGroupPendingModifiedValues.PrimaryClusterId"> <summary> The primary cluster ID which will be applied immediately (if <c>--apply-immediately</c> was specified), or during the next maintenance window. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ReservedCacheNode"> <summary> <para>Represents the output of a <i>PurchaseReservedCacheNodesOffering</i> operation.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithReservedCacheNodeId(System.String)"> <summary> Sets the ReservedCacheNodeId property </summary> <param name="reservedCacheNodeId">The value to set for the ReservedCacheNodeId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithReservedCacheNodesOfferingId(System.String)"> <summary> Sets the ReservedCacheNodesOfferingId property </summary> <param name="reservedCacheNodesOfferingId">The value to set for the ReservedCacheNodesOfferingId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithDuration(System.Int32)"> <summary> Sets the Duration property </summary> <param name="duration">The value to set for the Duration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithFixedPrice(System.Double)"> <summary> Sets the FixedPrice property </summary> <param name="fixedPrice">The value to set for the FixedPrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithUsagePrice(System.Double)"> <summary> Sets the UsagePrice property </summary> <param name="usagePrice">The value to set for the UsagePrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithCacheNodeCount(System.Int32)"> <summary> Sets the CacheNodeCount property </summary> <param name="cacheNodeCount">The value to set for the CacheNodeCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithProductDescription(System.String)"> <summary> Sets the ProductDescription property </summary> <param name="productDescription">The value to set for the ProductDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithOfferingType(System.String)"> <summary> Sets the OfferingType property </summary> <param name="offeringType">The value to set for the OfferingType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithRecurringCharges(Amazon.ElastiCache.Model.RecurringCharge[])"> <summary> Adds elements to the RecurringCharges collection </summary> <param name="recurringCharges">The values to add to the RecurringCharges collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNode.WithRecurringCharges(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.RecurringCharge})"> <summary> Adds elements to the RecurringCharges collection </summary> <param name="recurringCharges">The values to add to the RecurringCharges collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.ReservedCacheNodeId"> <summary> The unique identifier for the reservation. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.ReservedCacheNodesOfferingId"> <summary> The offering identifier. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.CacheNodeType"> <summary> The cache node type for the reserved cache nodes. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.StartTime"> <summary> The time the reservation started. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.Duration"> <summary> The duration of the reservation in seconds. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.FixedPrice"> <summary> The fixed price charged for this reserved cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.UsagePrice"> <summary> The hourly price charged for this reserved cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.CacheNodeCount"> <summary> The number of cache nodes that have been reserved. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.ProductDescription"> <summary> The description of the reserved cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.OfferingType"> <summary> The offering type of this reserved cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.State"> <summary> The state of the reserved cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNode.RecurringCharges"> <summary> The recurring price charged to run this reserved cache node. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ReservedCacheNodeAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodeAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new ReservedCacheNodeAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodeNotFoundException.#ctor(System.String)"> <summary> Constructs a new ReservedCacheNodeNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ReservedCacheNodeQuotaExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodeQuotaExceededException.#ctor(System.String)"> <summary> Constructs a new ReservedCacheNodeQuotaExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ReservedCacheNodesOffering"> <summary> <para>Describes all of the attributes of a reserved cache node offering.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithReservedCacheNodesOfferingId(System.String)"> <summary> Sets the ReservedCacheNodesOfferingId property </summary> <param name="reservedCacheNodesOfferingId">The value to set for the ReservedCacheNodesOfferingId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithDuration(System.Int32)"> <summary> Sets the Duration property </summary> <param name="duration">The value to set for the Duration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithFixedPrice(System.Double)"> <summary> Sets the FixedPrice property </summary> <param name="fixedPrice">The value to set for the FixedPrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithUsagePrice(System.Double)"> <summary> Sets the UsagePrice property </summary> <param name="usagePrice">The value to set for the UsagePrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithProductDescription(System.String)"> <summary> Sets the ProductDescription property </summary> <param name="productDescription">The value to set for the ProductDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithOfferingType(System.String)"> <summary> Sets the OfferingType property </summary> <param name="offeringType">The value to set for the OfferingType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithRecurringCharges(Amazon.ElastiCache.Model.RecurringCharge[])"> <summary> Adds elements to the RecurringCharges collection </summary> <param name="recurringCharges">The values to add to the RecurringCharges collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.WithRecurringCharges(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.RecurringCharge})"> <summary> Adds elements to the RecurringCharges collection </summary> <param name="recurringCharges">The values to add to the RecurringCharges collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.ReservedCacheNodesOfferingId"> <summary> A unique identifier for the reserved cache node offering. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.CacheNodeType"> <summary> The cache node type for the reserved cache node. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.Duration"> <summary> The duration of the offering. in seconds. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.FixedPrice"> <summary> The fixed price charged for this offering. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.UsagePrice"> <summary> The hourly price charged for this offering. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.ProductDescription"> <summary> The cache engine used by the offering. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.OfferingType"> <summary> The offering type. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ReservedCacheNodesOffering.RecurringCharges"> <summary> The recurring price charged to run this reserved cache node. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.ReservedCacheNodesOfferingNotFoundException.#ctor(System.String)"> <summary> Constructs a new ReservedCacheNodesOfferingNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest"> <summary> Container for the parameters to the ResetCacheParameterGroup operation. <para>The <i>ResetCacheParameterGroup</i> operation 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.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.ResetCacheParameterGroup(Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest.WithResetAllParameters(System.Boolean)"> <summary> Sets the ResetAllParameters property </summary> <param name="resetAllParameters">The value to set for the ResetAllParameters property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest.WithParameterNameValues(Amazon.ElastiCache.Model.ParameterNameValue[])"> <summary> Adds elements to the ParameterNameValues collection </summary> <param name="parameterNameValues">The values to add to the ParameterNameValues collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest.WithParameterNameValues(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.ParameterNameValue})"> <summary> Adds elements to the ParameterNameValues collection </summary> <param name="parameterNameValues">The values to add to the ParameterNameValues collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest.CacheParameterGroupName"> <summary> The name of the cache parameter group to reset. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest.ResetAllParameters"> <summary> If <i>true</i>, all parameters in the cache parameter group will be reset to default values. If <i>false</i>, no such action occurs. Valid values: <c>true</c> | <c>false</c> </summary> </member> <member name="P:Amazon.ElastiCache.Model.ResetCacheParameterGroupRequest.ParameterNameValues"> <summary> An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name. </summary> </member> <member name="T:Amazon.ElastiCache.Model.ResetCacheParameterGroupResponse"> <summary> Returns information about the ResetCacheParameterGroupResult response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.ResetCacheParameterGroupResponse.ResetCacheParameterGroupResult"> <summary> Gets and sets the ResetCacheParameterGroupResult property. Represents the output of one of the following operations: ModifyCacheParameterGroup ResetCacheParameterGroup </summary> </member> <member name="T:Amazon.ElastiCache.Model.ResetCacheParameterGroupResult"> <summary> <para>Represents the output of one of the following operations:</para> <ul> <li> <i>ModifyCacheParameterGroup</i> </li> <li> <i>ResetCacheParameterGroup</i> </li> </ul> </summary> </member> <member name="M:Amazon.ElastiCache.Model.ResetCacheParameterGroupResult.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.ResetCacheParameterGroupResult.CacheParameterGroupName"> <summary> The name of the cache parameter group. </summary> </member> <member name="T:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest"> <summary> Container for the parameters to the RevokeCacheSecurityGroupIngress operation. <para>The <i>RevokeCacheSecurityGroupIngress</i> operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.</para> </summary> <seealso cref="M:Amazon.ElastiCache.AmazonElastiCache.RevokeCacheSecurityGroupIngress(Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest)"/> </member> <member name="M:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest.WithCacheSecurityGroupName(System.String)"> <summary> Sets the CacheSecurityGroupName property </summary> <param name="cacheSecurityGroupName">The value to set for the CacheSecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest.WithEC2SecurityGroupName(System.String)"> <summary> Sets the EC2SecurityGroupName property </summary> <param name="eC2SecurityGroupName">The value to set for the EC2SecurityGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest.WithEC2SecurityGroupOwnerId(System.String)"> <summary> Sets the EC2SecurityGroupOwnerId property </summary> <param name="eC2SecurityGroupOwnerId">The value to set for the EC2SecurityGroupOwnerId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest.CacheSecurityGroupName"> <summary> The name of the cache security group to revoke ingress from. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest.EC2SecurityGroupName"> <summary> The name of the Amazon EC2 security group to revoke access from. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressRequest.EC2SecurityGroupOwnerId"> <summary> The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter. </summary> </member> <member name="T:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressResponse"> <summary> Returns information about the RevokeCacheSecurityGroupIngress response and response metadata. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressResponse.RevokeCacheSecurityGroupIngressResult"> Gets and sets the RevokeCacheSecurityGroupIngressResult property. Contains the result of a successful invocation of the RevokeCacheSecurityGroupIngress action. </member> <member name="T:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressResult"> <summary> The results from the RevokeCacheSecurityGroupIngress action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.RevokeCacheSecurityGroupIngressResult.CacheSecurityGroup"> <summary> Gets and sets the RevokeCacheSecurityGroupIngressResult property. Contains the result of a successful invocation of the RevokeCacheSecurityGroupIngress action. </summary> </member> <member name="T:Amazon.ElastiCache.Model.SecurityGroupMembership"> <summary> <para>Represents a single cache security group and its status..</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.SecurityGroupMembership.WithSecurityGroupId(System.String)"> <summary> Sets the SecurityGroupId property </summary> <param name="securityGroupId">The value to set for the SecurityGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.SecurityGroupMembership.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.SecurityGroupMembership.SecurityGroupId"> <summary> The identifier of the cache security group. </summary> </member> <member name="P:Amazon.ElastiCache.Model.SecurityGroupMembership.Status"> <summary> The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified. </summary> </member> <member name="T:Amazon.ElastiCache.Model.Snapshot"> <summary> <para>Represents a copy of an entire cache cluster as of the time when the snapshot was taken.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithSnapshotName(System.String)"> <summary> Sets the SnapshotName property </summary> <param name="snapshotName">The value to set for the SnapshotName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithCacheClusterId(System.String)"> <summary> Sets the CacheClusterId property </summary> <param name="cacheClusterId">The value to set for the CacheClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithSnapshotStatus(System.String)"> <summary> Sets the SnapshotStatus property </summary> <param name="snapshotStatus">The value to set for the SnapshotStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithSnapshotSource(System.String)"> <summary> Sets the SnapshotSource property </summary> <param name="snapshotSource">The value to set for the SnapshotSource property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithCacheNodeType(System.String)"> <summary> Sets the CacheNodeType property </summary> <param name="cacheNodeType">The value to set for the CacheNodeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithEngine(System.String)"> <summary> Sets the Engine property </summary> <param name="engine">The value to set for the Engine property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithEngineVersion(System.String)"> <summary> Sets the EngineVersion property </summary> <param name="engineVersion">The value to set for the EngineVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithNumCacheNodes(System.Int32)"> <summary> Sets the NumCacheNodes property </summary> <param name="numCacheNodes">The value to set for the NumCacheNodes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithPreferredAvailabilityZone(System.String)"> <summary> Sets the PreferredAvailabilityZone property </summary> <param name="preferredAvailabilityZone">The value to set for the PreferredAvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithCacheClusterCreateTime(System.DateTime)"> <summary> Sets the CacheClusterCreateTime property </summary> <param name="cacheClusterCreateTime">The value to set for the CacheClusterCreateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithPreferredMaintenanceWindow(System.String)"> <summary> Sets the PreferredMaintenanceWindow property </summary> <param name="preferredMaintenanceWindow">The value to set for the PreferredMaintenanceWindow property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithTopicArn(System.String)"> <summary> Sets the TopicArn property </summary> <param name="topicArn">The value to set for the TopicArn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithPort(System.Int32)"> <summary> Sets the Port property </summary> <param name="port">The value to set for the Port property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithCacheParameterGroupName(System.String)"> <summary> Sets the CacheParameterGroupName property </summary> <param name="cacheParameterGroupName">The value to set for the CacheParameterGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithCacheSubnetGroupName(System.String)"> <summary> Sets the CacheSubnetGroupName property </summary> <param name="cacheSubnetGroupName">The value to set for the CacheSubnetGroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithVpcId(System.String)"> <summary> Sets the VpcId property </summary> <param name="vpcId">The value to set for the VpcId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithAutoMinorVersionUpgrade(System.Boolean)"> <summary> Sets the AutoMinorVersionUpgrade property </summary> <param name="autoMinorVersionUpgrade">The value to set for the AutoMinorVersionUpgrade property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithSnapshotRetentionLimit(System.Int32)"> <summary> Sets the SnapshotRetentionLimit property </summary> <param name="snapshotRetentionLimit">The value to set for the SnapshotRetentionLimit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithSnapshotWindow(System.String)"> <summary> Sets the SnapshotWindow property </summary> <param name="snapshotWindow">The value to set for the SnapshotWindow property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithNodeSnapshots(Amazon.ElastiCache.Model.NodeSnapshot[])"> <summary> Adds elements to the NodeSnapshots collection </summary> <param name="nodeSnapshots">The values to add to the NodeSnapshots collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Snapshot.WithNodeSnapshots(System.Collections.Generic.IEnumerable{Amazon.ElastiCache.Model.NodeSnapshot})"> <summary> Adds elements to the NodeSnapshots collection </summary> <param name="nodeSnapshots">The values to add to the NodeSnapshots collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.SnapshotName"> <summary> The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.CacheClusterId"> <summary> The user-supplied identifier of the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.SnapshotStatus"> <summary> The status of the snapshot. Valid values: <c>creating</c> | <c>available</c> | <c>restoring</c> | <c>deleting</c>. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.SnapshotSource"> <summary> Indicates whether the snapshot is from an automatic backup (<c>automated</c>) or was created manually (<c>manual</c>). </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.CacheNodeType"> <summary> The name of the compute and memory capacity node type for the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.Engine"> <summary> The name of the cache engine (<i>memcached</i> or <i>redis</i>) used by the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.EngineVersion"> <summary> The version of the cache engine version that is used by the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.NumCacheNodes"> <summary> The number of cache nodes in the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.PreferredAvailabilityZone"> <summary> The name of the Availability Zone in which the source cache cluster is located. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.CacheClusterCreateTime"> <summary> The date and time when the source cache cluster was created. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.PreferredMaintenanceWindow"> <summary> The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.TopicArn"> <summary> The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.Port"> <summary> The port number used by each cache nodes in the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.CacheParameterGroupName"> <summary> The cache parameter group that is associated with the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.CacheSubnetGroupName"> <summary> The name of the cache subnet group associated with the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.VpcId"> <summary> The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.AutoMinorVersionUpgrade"> <summary> For the source cache cluster, indicates whether minor version patches are applied automatically (<c>true</c>) or not (<c>false</c>). </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.SnapshotRetentionLimit"> <summary> For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it. For manual snapshots, this field reflects the <i>SnapshotRetentionLimit</i> for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the <i>DeleteSnapshot</i> action. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.SnapshotWindow"> <summary> The daily time range during which ElastiCache takes daily snapshots of the source cache cluster. </summary> </member> <member name="P:Amazon.ElastiCache.Model.Snapshot.NodeSnapshots"> <summary> A list of the cache cluster nodes in the source cache cluster. </summary> </member> <member name="T:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.SnapshotAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new SnapshotAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.SnapshotFeatureNotSupportedException.#ctor(System.String)"> <summary> Constructs a new SnapshotFeatureNotSupportedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.SnapshotNotFoundException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.SnapshotNotFoundException.#ctor(System.String)"> <summary> Constructs a new SnapshotNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.SnapshotQuotaExceededException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.SnapshotQuotaExceededException.#ctor(System.String)"> <summary> Constructs a new SnapshotQuotaExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElastiCache.Model.Subnet"> <summary> <para>Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.</para> </summary> </member> <member name="M:Amazon.ElastiCache.Model.Subnet.WithSubnetIdentifier(System.String)"> <summary> Sets the SubnetIdentifier property </summary> <param name="subnetIdentifier">The value to set for the SubnetIdentifier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElastiCache.Model.Subnet.WithSubnetAvailabilityZone(Amazon.ElastiCache.Model.AvailabilityZone)"> <summary> Sets the SubnetAvailabilityZone property </summary> <param name="subnetAvailabilityZone">The value to set for the SubnetAvailabilityZone property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElastiCache.Model.Subnet.SubnetIdentifier"> <summary> The unique identifier for the subnet </summary> </member> <member name="P:Amazon.ElastiCache.Model.Subnet.SubnetAvailabilityZone"> <summary> The Availability Zone associated with the subnet </summary> </member> <member name="T:Amazon.ElastiCache.Model.SubnetInUseException"> <summary> AmazonElastiCache exception </summary> </member> <member name="M:Amazon.ElastiCache.Model.SubnetInUseException.#ctor(System.String)"> <summary> Constructs a new SubnetInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"> <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>. </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.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginCheckDNSAvailability(Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CheckDNSAvailability operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CheckDNSAvailability operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCheckDNSAvailability operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndCheckDNSAvailability(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CheckDNSAvailability operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCheckDNSAvailability.</param> <returns>Returns a CheckDNSAvailabilityResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.CreateApplication(Amazon.ElasticBeanstalk.Model.CreateApplicationRequest)"> <summary> Creates an application that has one configuration template named <code>default</code> and no application versions. The <code>default</code> configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6 application container. </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 caller has exceeded the limit on the number of applications associated with their account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginCreateApplication(Amazon.ElasticBeanstalk.Model.CreateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateApplication operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndCreateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateApplication.</param> <returns>Returns a CreateApplicationResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream 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 caller has exceeded the limit on the number of applications associated with their account. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationVersionsException"> The caller has exceeded the limit on the number of application versions associated with their account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginCreateApplicationVersion(Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateApplicationVersion operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateApplicationVersion operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndCreateApplicationVersion(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateApplicationVersion.</param> <returns>Returns a CreateApplicationVersionResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyConfigurationTemplatesException"> The caller has exceeded the limit on the number of configuration templates associated with their account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginCreateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateConfigurationTemplate operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateConfigurationTemplate operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndCreateConfigurationTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateConfigurationTemplate.</param> <returns>Returns a CreateConfigurationTemplateResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException"> The caller has exceeded the limit of allowed environments associated with the account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginCreateEnvironment(Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndCreateEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateEnvironment.</param> <returns>Returns a CreateEnvironmentResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The caller does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The caller does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginCreateStorageLocation(Amazon.ElasticBeanstalk.Model.CreateStorageLocationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStorageLocation operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateStorageLocation operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStorageLocation operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndCreateStorageLocation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStorageLocation operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStorageLocation.</param> <returns>Returns a CreateStorageLocationResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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 is already in progress affecting an an element in this activity. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginDeleteApplication(Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteApplication operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDeleteApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteApplication.</param> <returns>Returns a DeleteApplicationResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity. </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, although the application version deleted successfully. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginDeleteApplicationVersion(Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplicationVersion operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteApplicationVersion operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDeleteApplicationVersion(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteApplicationVersion.</param> <returns>Returns a DeleteApplicationVersionResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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 is already in progress affecting an an element in this activity. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginDeleteConfigurationTemplate(Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigurationTemplate operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteConfigurationTemplate operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDeleteConfigurationTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConfigurationTemplate.</param> <returns>Returns a DeleteConfigurationTemplateResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginDeleteEnvironmentConfiguration(Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEnvironmentConfiguration operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteEnvironmentConfiguration operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDeleteEnvironmentConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteEnvironmentConfiguration operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteEnvironmentConfiguration.</param> <returns>Returns a DeleteEnvironmentConfigurationResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginDescribeApplications(Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeApplications operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplications operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeApplications operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDescribeApplications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeApplications operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeApplications.</param> <returns>Returns a DescribeApplicationsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.DescribeApplicationVersions"> <summary> Returns descriptions for existing application versions. </summary> <returns>The response from the DescribeApplicationVersions service method, as returned by ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.DescribeApplicationVersions(Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest)"> <summary> Returns descriptions for existing application versions. </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.AmazonElasticBeanstalk.BeginDescribeApplicationVersions(Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeApplicationVersions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplicationVersions operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeApplicationVersions operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDescribeApplicationVersions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeApplicationVersions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeApplicationVersions.</param> <returns>Returns a DescribeApplicationVersionsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginDescribeConfigurationOptions(Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationOptions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationOptions operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationOptions operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDescribeConfigurationOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationOptions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationOptions.</param> <returns>Returns a DescribeConfigurationOptionsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginDescribeConfigurationSettings(Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationSettings operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationSettings operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDescribeConfigurationSettings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationSettings.</param> <returns>Returns a DescribeConfigurationSettingsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginDescribeEnvironmentResources(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEnvironmentResources operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentResources operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEnvironmentResources operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDescribeEnvironmentResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEnvironmentResources operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEnvironmentResources.</param> <returns>Returns a DescribeEnvironmentResourcesResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginDescribeEnvironments(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEnvironments operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironments operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEnvironments operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDescribeEnvironments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEnvironments operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEnvironments.</param> <returns>Returns a DescribeEnvironmentsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginDescribeEvents(Amazon.ElasticBeanstalk.Model.DescribeEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEvents operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndDescribeEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEvents operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEvents.</param> <returns>Returns a DescribeEventsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginListAvailableSolutionStacks(Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAvailableSolutionStacks operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableSolutionStacks operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAvailableSolutionStacks operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndListAvailableSolutionStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAvailableSolutionStacks operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAvailableSolutionStacks.</param> <returns>Returns a ListAvailableSolutionStacksResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginRebuildEnvironment(Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RebuildEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RebuildEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRebuildEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndRebuildEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RebuildEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRebuildEnvironment.</param> <returns>Returns a RebuildEnvironmentResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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. Use <a>RetrieveEnvironmentInfo</a> to access the compiled information. </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.AmazonElasticBeanstalk.BeginRequestEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RequestEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RequestEnvironmentInfo operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRequestEnvironmentInfo operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndRequestEnvironmentInfo(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RequestEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRequestEnvironmentInfo.</param> <returns>Returns a RequestEnvironmentInfoResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginRestartAppServer(Amazon.ElasticBeanstalk.Model.RestartAppServerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RestartAppServer operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RestartAppServer operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestartAppServer operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndRestartAppServer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RestartAppServer operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRestartAppServer.</param> <returns>Returns a RestartAppServerResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginRetrieveEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveEnvironmentInfo operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRetrieveEnvironmentInfo operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndRetrieveEnvironmentInfo(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RetrieveEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRetrieveEnvironmentInfo.</param> <returns>Returns a RetrieveEnvironmentInfoResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginSwapEnvironmentCNAMEs(Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the SwapEnvironmentCNAMEs operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSwapEnvironmentCNAMEs operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndSwapEnvironmentCNAMEs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SwapEnvironmentCNAMEs operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSwapEnvironmentCNAMEs.</param> <returns>Returns a SwapEnvironmentCNAMEsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginTerminateEnvironment(Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the TerminateEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndTerminateEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateEnvironment.</param> <returns>Returns a TerminateEnvironmentResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginUpdateApplication(Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateApplication operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndUpdateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateApplication.</param> <returns>Returns a UpdateApplicationResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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.AmazonElasticBeanstalk.BeginUpdateApplicationVersion(Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplicationVersion operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateApplicationVersion operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndUpdateApplicationVersion(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateApplicationVersion.</param> <returns>Returns a UpdateApplicationVersionResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginUpdateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateConfigurationTemplate operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateConfigurationTemplate operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndUpdateConfigurationTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateConfigurationTemplate.</param> <returns>Returns a UpdateConfigurationTemplateResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginUpdateEnvironment(Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndUpdateEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateEnvironment.</param> <returns>Returns a UpdateEnvironmentResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.BeginValidateConfigurationSettings(Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidateConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the ValidateConfigurationSettings operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidateConfigurationSettings operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk.EndValidateConfigurationSettings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidateConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidateConfigurationSettings.</param> <returns>Returns a ValidateConfigurationSettingsResult from ElasticBeanstalk.</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>. </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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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.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.BeginCheckDNSAvailability(Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CheckDNSAvailability operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CheckDNSAvailability operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCheckDNSAvailability operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndCheckDNSAvailability(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CheckDNSAvailability operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCheckDNSAvailability.</param> <returns>Returns a CheckDNSAvailabilityResult from ElasticBeanstalk.</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. The <code>default</code> configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6 application container. </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 caller has exceeded the limit on the number of applications associated with their account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginCreateApplication(Amazon.ElasticBeanstalk.Model.CreateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateApplication operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndCreateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateApplication.</param> <returns>Returns a CreateApplicationResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream 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 caller has exceeded the limit on the number of applications associated with their account. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationVersionsException"> The caller has exceeded the limit on the number of application versions associated with their account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginCreateApplicationVersion(Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateApplicationVersion operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateApplicationVersion operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndCreateApplicationVersion(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateApplicationVersion.</param> <returns>Returns a CreateApplicationVersionResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyConfigurationTemplatesException"> The caller has exceeded the limit on the number of configuration templates associated with their account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginCreateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateConfigurationTemplate operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateConfigurationTemplate operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndCreateConfigurationTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateConfigurationTemplate.</param> <returns>Returns a CreateConfigurationTemplateResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException"> The caller has exceeded the limit of allowed environments associated with the account. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginCreateEnvironment(Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndCreateEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateEnvironment.</param> <returns>Returns a CreateEnvironmentResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The caller does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The web service attempted to create a bucket in an Amazon S3 account that already has 100 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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> The caller does not have a subscription to Amazon S3. </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginCreateStorageLocation(Amazon.ElasticBeanstalk.Model.CreateStorageLocationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStorageLocation operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateStorageLocation operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStorageLocation operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndCreateStorageLocation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStorageLocation operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStorageLocation.</param> <returns>Returns a CreateStorageLocationResult from ElasticBeanstalk.</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 is already in progress affecting an an element in this activity. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginDeleteApplication(Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteApplication operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDeleteApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteApplication.</param> <returns>Returns a DeleteApplicationResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> <exception cref="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity. </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, although the application version deleted successfully. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginDeleteApplicationVersion(Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplicationVersion operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteApplicationVersion operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDeleteApplicationVersion(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteApplicationVersion.</param> <returns>Returns a DeleteApplicationVersionResult from ElasticBeanstalk.</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 is already in progress affecting an an element in this activity. </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginDeleteConfigurationTemplate(Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigurationTemplate operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteConfigurationTemplate operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDeleteConfigurationTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConfigurationTemplate.</param> <returns>Returns a DeleteConfigurationTemplateResult from ElasticBeanstalk.</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.BeginDeleteEnvironmentConfiguration(Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteEnvironmentConfiguration operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteEnvironmentConfiguration operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDeleteEnvironmentConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteEnvironmentConfiguration operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteEnvironmentConfiguration.</param> <returns>Returns a DeleteEnvironmentConfigurationResult from ElasticBeanstalk.</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.BeginDescribeApplications(Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeApplications operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplications operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeApplications operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDescribeApplications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeApplications operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeApplications.</param> <returns>Returns a DescribeApplicationsResult from ElasticBeanstalk.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.DescribeApplicationVersions"> <summary> Returns descriptions for existing application versions. </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> Returns descriptions for existing application versions. </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.BeginDescribeApplicationVersions(Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeApplicationVersions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeApplicationVersions operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeApplicationVersions operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDescribeApplicationVersions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeApplicationVersions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeApplicationVersions.</param> <returns>Returns a DescribeApplicationVersionsResult from ElasticBeanstalk.</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.BeginDescribeConfigurationOptions(Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationOptions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationOptions operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationOptions operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDescribeConfigurationOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationOptions operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationOptions.</param> <returns>Returns a DescribeConfigurationOptionsResult from ElasticBeanstalk.</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.BeginDescribeConfigurationSettings(Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationSettings operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationSettings operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDescribeConfigurationSettings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationSettings.</param> <returns>Returns a DescribeConfigurationSettingsResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginDescribeEnvironmentResources(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEnvironmentResources operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironmentResources operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEnvironmentResources operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDescribeEnvironmentResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEnvironmentResources operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEnvironmentResources.</param> <returns>Returns a DescribeEnvironmentResourcesResult from ElasticBeanstalk.</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.BeginDescribeEnvironments(Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEnvironments operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEnvironments operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEnvironments operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDescribeEnvironments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEnvironments operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEnvironments.</param> <returns>Returns a DescribeEnvironmentsResult from ElasticBeanstalk.</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.BeginDescribeEvents(Amazon.ElasticBeanstalk.Model.DescribeEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEvents operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEvents operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEvents operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndDescribeEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEvents operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEvents.</param> <returns>Returns a DescribeEventsResult from ElasticBeanstalk.</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.BeginListAvailableSolutionStacks(Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAvailableSolutionStacks operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableSolutionStacks operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAvailableSolutionStacks operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndListAvailableSolutionStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAvailableSolutionStacks operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAvailableSolutionStacks.</param> <returns>Returns a ListAvailableSolutionStacksResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginRebuildEnvironment(Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RebuildEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RebuildEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRebuildEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndRebuildEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RebuildEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRebuildEnvironment.</param> <returns>Returns a RebuildEnvironmentResult from ElasticBeanstalk.</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. Use <a>RetrieveEnvironmentInfo</a> to access the compiled information. </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.BeginRequestEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RequestEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RequestEnvironmentInfo operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRequestEnvironmentInfo operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndRequestEnvironmentInfo(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RequestEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRequestEnvironmentInfo.</param> <returns>Returns a RequestEnvironmentInfoResult from ElasticBeanstalk.</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.BeginRestartAppServer(Amazon.ElasticBeanstalk.Model.RestartAppServerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RestartAppServer operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RestartAppServer operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestartAppServer operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndRestartAppServer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RestartAppServer operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRestartAppServer.</param> <returns>Returns a RestartAppServerResult from ElasticBeanstalk.</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.BeginRetrieveEnvironmentInfo(Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the RetrieveEnvironmentInfo operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRetrieveEnvironmentInfo operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndRetrieveEnvironmentInfo(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RetrieveEnvironmentInfo operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRetrieveEnvironmentInfo.</param> <returns>Returns a RetrieveEnvironmentInfoResult from ElasticBeanstalk.</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.BeginSwapEnvironmentCNAMEs(Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the SwapEnvironmentCNAMEs operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSwapEnvironmentCNAMEs operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndSwapEnvironmentCNAMEs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SwapEnvironmentCNAMEs operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSwapEnvironmentCNAMEs.</param> <returns>Returns a SwapEnvironmentCNAMEsResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginTerminateEnvironment(Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the TerminateEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndTerminateEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateEnvironment.</param> <returns>Returns a TerminateEnvironmentResult from ElasticBeanstalk.</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.BeginUpdateApplication(Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateApplication operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndUpdateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateApplication operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateApplication.</param> <returns>Returns a UpdateApplicationResult from ElasticBeanstalk.</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.BeginUpdateApplicationVersion(Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplicationVersion operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateApplicationVersion operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndUpdateApplicationVersion(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateApplicationVersion operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateApplicationVersion.</param> <returns>Returns a UpdateApplicationVersionResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginUpdateConfigurationTemplate(Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateConfigurationTemplate operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateConfigurationTemplate operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndUpdateConfigurationTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateConfigurationTemplate operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateConfigurationTemplate.</param> <returns>Returns a UpdateConfigurationTemplateResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginUpdateEnvironment(Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateEnvironment operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateEnvironment operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndUpdateEnvironment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateEnvironment operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateEnvironment.</param> <returns>Returns a UpdateEnvironmentResult from ElasticBeanstalk.</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"> Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services </exception> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.BeginValidateConfigurationSettings(Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidateConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="request">Container for the necessary parameters to execute the ValidateConfigurationSettings operation on AmazonElasticBeanstalkClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidateConfigurationSettings operation.</returns> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkClient.EndValidateConfigurationSettings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidateConfigurationSettings operation. <seealso cref="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalk"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidateConfigurationSettings.</param> <returns>Returns a ValidateConfigurationSettingsResult from ElasticBeanstalk.</returns> </member> <member name="T:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig"> <summary> Configuration for accessing Amazon ElasticBeanstalk service </summary> </member> <member name="M:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.AmazonElasticBeanstalkConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ApplicationDescription"> <summary> Describes the properties of an application. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithConfigurationTemplates(System.String[])"> <summary> Sets the ConfigurationTemplates property </summary> <param name="configurationTemplates">The values to add to the ConfigurationTemplates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithConfigurationTemplates(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ConfigurationTemplates property </summary> <param name="configurationTemplates">The values to add to the ConfigurationTemplates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithVersions(System.String[])"> <summary> Sets the Versions property </summary> <param name="versions">The values to add to the Versions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationDescription.WithVersions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Versions property </summary> <param name="versions">The values to add to the Versions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationDescription.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationDescription.ConfigurationTemplates"> <summary> Gets and sets the property ConfigurationTemplates. <para> The names of the configuration templates associated with this application. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationDescription.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The date when the application was created. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationDescription.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The date when the application was last modified. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationDescription.Description"> <summary> Gets and sets the property Description. <para> User-defined description of the application. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationDescription.Versions"> <summary> Gets and sets the property Versions. <para> The names of the versions for this application. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription"> <summary> Describes the properties of an application version. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.WithSourceBundle(Amazon.ElasticBeanstalk.Model.S3Location)"> <summary> Sets the SourceBundle property </summary> <param name="sourceBundle">The value to set for the SourceBundle property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this release. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The creation date of the application version. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The last modified date of the application version. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.Description"> <summary> Gets and sets the property Description. <para> The description of this application version. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.SourceBundle"> <summary> Gets and sets the property SourceBundle. <para> The location where the source bundle is located for this version. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> A label uniquely identifying the version for the associated application. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.AutoScalingGroup"> <summary> Describes an Auto Scaling launch configuration. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.AutoScalingGroup.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.AutoScalingGroup.Name"> <summary> Gets and sets the property Name. <para> The name of the <code>AutoScalingGroup</code> . </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest"> <summary> Container for the parameters to the CheckDNSAvailability operation. Checks if the specified CNAME is available. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest.WithCNAMEPrefix(System.String)"> <summary> Sets the CNAMEPrefix property </summary> <param name="cNAMEPrefix">The value to set for the CNAMEPrefix property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityRequest.CNAMEPrefix"> <summary> Gets and sets the property CNAMEPrefix. <para> The prefix used when this CNAME is reserved. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityResponse"> <summary> Returns information about the CheckDNSAvailabilityResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityResponse.CheckDNSAvailabilityResult"> <summary> Gets and sets the CheckDNSAvailabilityResult property. Represents the output of a CheckDNSAvailability operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityResult"> <summary> Indicates if the specified CNAME is available. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityResult.WithAvailable(System.Boolean)"> <summary> Sets the Available property </summary> <param name="available">The value to set for the Available property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityResult.WithFullyQualifiedCNAME(System.String)"> <summary> Sets the FullyQualifiedCNAME property </summary> <param name="fullyQualifiedCNAME">The value to set for the FullyQualifiedCNAME property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityResult.Available"> <summary> Gets and sets the property Available. <para> Indicates if the specified CNAME is available: </para> <enumValues> <value name="true"> <para> <code>true</code> : The CNAME is available. </para> </value> <value name="false"> <para> <code>true</code> : The CNAME is not available. </para> </value> </enumValues> <para> <ul> <li> <code>true</code> : The CNAME is available. </li> <li> <code>false</code> : The CNAME is not available. </li> </ul> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CheckDNSAvailabilityResult.FullyQualifiedCNAME"> <summary> Gets and sets the property FullyQualifiedCNAME. <para> The fully qualified CNAME to reserve when <a>CreateEnvironment</a> is called with the provided prefix. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription"> <summary> Describes the possible values for a configuration option. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithChangeSeverity(System.String)"> <summary> Sets the ChangeSeverity property </summary> <param name="changeSeverity">The value to set for the ChangeSeverity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithMaxLength(System.Int32)"> <summary> Sets the MaxLength property </summary> <param name="maxLength">The value to set for the MaxLength property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithMaxValue(System.Int32)"> <summary> Sets the MaxValue property </summary> <param name="maxValue">The value to set for the MaxValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithMinValue(System.Int32)"> <summary> Sets the MinValue property </summary> <param name="minValue">The value to set for the MinValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="ns">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithRegex(Amazon.ElasticBeanstalk.Model.OptionRestrictionRegex)"> <summary> Sets the Regex property </summary> <param name="regex">The value to set for the Regex property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithUserDefined(System.Boolean)"> <summary> Sets the UserDefined property </summary> <param name="userDefined">The value to set for the UserDefined property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithValueOptions(System.String[])"> <summary> Sets the ValueOptions property </summary> <param name="valueOptions">The values to add to the ValueOptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithValueOptions(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ValueOptions property </summary> <param name="valueOptions">The values to add to the ValueOptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.WithValueType(System.String)"> <summary> Sets the ValueType property </summary> <param name="valueType">The value to set for the ValueType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.ChangeSeverity"> <summary> Gets and sets the property ChangeSeverity. <para> An indication of which action is required if the value for this configuration option changes: </para> <enumValues> <value name="NoInterruption"> <para> NoInterruption - There is no interruption to the environment or application availability. </para> </value> <value name="RestartEnvironment"> <para> RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process. </para> </value> <value name="RestartApplicationServer"> <para> RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted. </para> </value> </enumValues> <ul> <li> <code>NoInterruption</code> : There is no interruption to the environment or application availability. </li> <li> <code>RestartEnvironment</code> : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process. </li> <li> <code>RestartApplicationServer</code> : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value for this configuration option. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.MaxLength"> <summary> Gets and sets the property MaxLength. <para> If specified, the configuration option must be a string value no longer than this value. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.MaxValue"> <summary> Gets and sets the property MaxValue. <para> If specified, the configuration option must be a numeric value less than this value. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.MinValue"> <summary> Gets and sets the property MinValue. <para> If specified, the configuration option must be a numeric value greater than this value. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.Name"> <summary> Gets and sets the property Name. <para> The name of the configuration option. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.Namespace"> <summary> Gets and sets the property Namespace. <para> A unique namespace identifying the option's associated AWS resource. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.Regex"> <summary> Gets and sets the property Regex. <para> If specified, the configuration option must be a string value that satisfies this regular expression. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.UserDefined"> <summary> Gets and sets the property UserDefined. <para> An indication of whether the user defined this configuration option: </para> <enumValues> <value name="true"> <para> <code>true</code> : This configuration option was defined by the user. It is a valid choice for specifying this as an Option to Remove when updating configuration settings. </para> </value> <value name="false"> <para> <code>false</code> : This configuration was not defined by the user. </para> </value> </enumValues> <ul> <li> <para> <code>true</code> : This configuration option was defined by the user. It is a valid choice for specifying if this as an <code>Option to Remove</code> when updating configuration settings. </para> </li> <li> <code>false</code> : This configuration was not defined by the user. </li> </ul> <para> Constraint: You can remove only <code>UserDefined</code> options from a configuration. </para> <para> Valid Values: <code>true</code> | <code>false</code> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.ValueOptions"> <summary> Gets and sets the property ValueOptions. <para> If specified, values for the configuration option are selected from this list. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription.ValueType"> <summary> Gets and sets the property ValueType. <para> An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values: </para> <enumValues> <value name="Scalar"> <para> <code>Scalar</code> : Values for this option are a single selection from the possible values, or a unformatted string or numeric value governed by the MIN/MAX/Regex constraints: </para> </value> <value name="List"> <para> <code>List</code> : Values for this option are multiple selections of the possible values. </para> </value> <value name="Boolean"> <para> <code>Boolean</code> : Values for this option are either <code>true</code> or <code>false</code> . </para> </value> </enumValues> <para> <ul> <li> <code>Scalar</code> : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the <code>MIN/MAX/Regex</code> constraints. </li> <li> <code>List</code> : Values for this option are multiple selections from the possible values. </li> <li> <code>Boolean</code> : Values for this option are either <code>true</code> or <code>false</code> . </li> </ul> </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting"> <summary> A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html">Option Values</a> in the <i>AWS Elastic Beanstalk Developer Guide</i>. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="ns">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting.WithOptionName(System.String)"> <summary> Sets the OptionName property </summary> <param name="optionName">The value to set for the OptionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting.Namespace"> <summary> Gets and sets the property Namespace. <para> A unique namespace identifying the option's associated AWS resource. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting.OptionName"> <summary> Gets and sets the property OptionName. <para> The name of the configuration option. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting.Value"> <summary> Gets and sets the property Value. <para> The current value for the configuration option. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription"> <summary> Describes the settings for a configuration set. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithDeploymentStatus(System.String)"> <summary> Sets the DeploymentStatus property </summary> <param name="deploymentStatus">The value to set for the DeploymentStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The date (in UTC time) when this configuration set was created. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The date (in UTC time) when this configuration set was last modified. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.DeploymentStatus"> <summary> Gets and sets the property DeploymentStatus. <para> If this configuration set is associated with an environment, the <code>DeploymentStatus</code> parameter indicates the deployment status of this configuration set: </para> <enumValues> <value name="null"> <para> <code>null</code>: This configuration is not associated with a running environment. </para> </value> <value name="pending"> <para> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. </para> </value> <value name="deployed"> <para> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment. </para> </value> <value name="failed"> <para> <code>failed</code>: This is a draft configuration, that failed to successfully deploy. </para> </value> </enumValues> <ul> <li> <code>null</code>: This configuration is not associated with a running environment. </li> <li> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. </li> <li> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment. </li> <li> <code>failed</code>: This is a draft configuration that failed to successfully deploy. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.Description"> <summary> Gets and sets the property Description. <para> Describes this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> If not <code>null</code>, the name of the environment for this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> A list of the configuration options and their values in this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the solution stack this configuration set uses. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription.TemplateName"> <summary> Gets and sets the property TemplateName. <para> If not <code>null</code>, the name of the configuration template for this configuration set. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateApplicationRequest"> <summary> Container for the parameters to the CreateApplication operation. Creates an application that has one configuration template named <code>default</code> and no application versions. The <code>default</code> configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6 application container. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application. </para> <para> Constraint: This name must be unique within your account. If the specified name already exists, the action returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationRequest.Description"> <summary> Gets and sets the property Description. <para> Describes the application. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateApplicationResponse"> <summary> Returns information about the CreateApplicationResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationResponse.CreateApplicationResult"> <summary> Gets and sets the CreateApplicationResult property. Represents the output of a CreateApplication operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateApplicationResult"> <summary> Result message containing a single description of an application. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationResult.WithApplication(Amazon.ElasticBeanstalk.Model.ApplicationDescription)"> <summary> Sets the Application property </summary> <param name="application">The value to set for the Application property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationResult.Application"> <summary> Gets and sets the property Application. <para> The <a>ApplicationDescription</a> of the application. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest"> <summary> Container for the parameters to the CreateApplicationVersion operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.WithAutoCreateApplication(System.Boolean)"> <summary> Sets the AutoCreateApplication property </summary> <param name="autoCreateApplication">The value to set for the AutoCreateApplication property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.WithSourceBundle(Amazon.ElasticBeanstalk.Model.S3Location)"> <summary> Sets the SourceBundle property </summary> <param name="sourceBundle">The value to set for the SourceBundle property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application. If no application is found with this name, and <code>AutoCreateApplication</code> is <code>false</code>, returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.AutoCreateApplication"> <summary> Gets and sets the property AutoCreateApplication. <para> Determines how the system behaves if the specified application for this version does not already exist: </para> <enumValues> <value name="true"> <para> <code>true</code>: Automatically creates the specified application for this version if it does not already exist. </para> </value> <value name="false"> <para> <code>false</code>: Returns an <code>InvalidParameterValue</code> if the specified application for this version does not already exist. </para> </value> </enumValues> <ul> <li> <code>true</code> : Automatically creates the specified application for this release if it does not already exist. </li> <li> <code>false</code> : Throws an <code>InvalidParameterValue</code> if the specified application for this release does not already exist. </li> </ul> <para> Default: <code>false</code> </para> <para> Valid Values: <code>true</code> | <code>false</code> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.Description"> <summary> Gets and sets the property Description. <para> Describes this version. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.SourceBundle"> <summary> Gets and sets the property SourceBundle. <para> The Amazon S3 bucket and key that identify the location of the source bundle for this version. </para> <para> If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. The maximum size allowed is 512 MB. </para> <para> Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionRequest.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> A label identifying this version. </para> <para> Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResponse"> <summary> Returns information about the CreateApplicationVersionResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResponse.CreateApplicationVersionResult"> <summary> Gets and sets the CreateApplicationVersionResult property. Represents the output of a CreateApplicationVersion operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResult"> <summary> Result message wrapping a single description of an application version. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResult.WithApplicationVersion(Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription)"> <summary> Sets the ApplicationVersion property </summary> <param name="applicationVersion">The value to set for the ApplicationVersion property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateApplicationVersionResult.ApplicationVersion"> <summary> Gets and sets the property ApplicationVersion. <para> The <a>ApplicationVersionDescription</a> of the application version. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest"> <summary> Container for the parameters to the CreateConfigurationTemplate operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithSourceConfiguration(Amazon.ElasticBeanstalk.Model.SourceConfiguration)"> <summary> Sets the SourceConfiguration property </summary> <param name="sourceConfiguration">The value to set for the SourceConfiguration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.Description"> <summary> Gets and sets the property Description. <para> Describes this configuration. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the environment used with this configuration template. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values. </para> <para> Use <a>ListAvailableSolutionStacks</a> to obtain a list of available solution stacks. </para> <para> A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> <para> If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.SourceConfiguration"> <summary> Gets and sets the property SourceConfiguration. <para> If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. </para> <para> Values specified in the <code>OptionSettings</code> parameter of this call overrides any values obtained from the <code>SourceConfiguration</code>. </para> <para> If no configuration template is found, returns an <code>InvalidParameterValue</code> error. </para> <para> Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template. </para> <para> Constraint: This name must be unique per application. </para> <para> Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResponse"> <summary> Returns information about the CreateConfigurationTemplateResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResponse.CreateConfigurationTemplateResult"> <summary> Gets and sets the CreateConfigurationTemplateResult property. Represents the output of a CreateConfigurationTemplate operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult"> <summary> Describes the settings for a configuration set. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithDeploymentStatus(System.String)"> <summary> Sets the DeploymentStatus property </summary> <param name="deploymentStatus">The value to set for the DeploymentStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The date (in UTC time) when this configuration set was created. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The date (in UTC time) when this configuration set was last modified. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.DeploymentStatus"> <summary> Gets and sets the property DeploymentStatus. <para> If this configuration set is associated with an environment, the <code>DeploymentStatus</code> parameter indicates the deployment status of this configuration set: </para> <enumValues> <value name="null"> <para> <code>null</code>: This configuration is not associated with a running environment. </para> </value> <value name="pending"> <para> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. </para> </value> <value name="deployed"> <para> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment. </para> </value> <value name="failed"> <para> <code>failed</code>: This is a draft configuration, that failed to successfully deploy. </para> </value> </enumValues> <ul> <li> <code>null</code>: This configuration is not associated with a running environment. </li> <li> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. </li> <li> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment. </li> <li> <code>failed</code>: This is a draft configuration that failed to successfully deploy. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.Description"> <summary> Gets and sets the property Description. <para> Describes this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> If not <code>null</code>, the name of the environment for this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> A list of the configuration options and their values in this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the solution stack this configuration set uses. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateConfigurationTemplateResult.TemplateName"> <summary> Gets and sets the property TemplateName. <para> If not <code>null</code>, the name of the configuration template for this configuration set. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest"> <summary> Container for the parameters to the CreateEnvironment operation. Launches an environment for the specified application using the specified configuration. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithCNAMEPrefix(System.String)"> <summary> Sets the CNAMEPrefix property </summary> <param name="cNAMEPrefix">The value to set for the CNAMEPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithOptionsToRemove(Amazon.ElasticBeanstalk.Model.OptionSpecification[])"> <summary> Sets the OptionsToRemove property </summary> <param name="optionsToRemove">The values to add to the OptionsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithOptionsToRemove(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.OptionSpecification})"> <summary> Sets the OptionsToRemove property </summary> <param name="optionsToRemove">The values to add to the OptionsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithTags(Amazon.ElasticBeanstalk.Model.Tag[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithTags(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.Tag})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithTier(Amazon.ElasticBeanstalk.Model.EnvironmentTier)"> <summary> Sets the Tier property </summary> <param name="tier">The value to set for the Tier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application that contains the version to be deployed. </para> <para> If no application is found with this name, <code>CreateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.CNAMEPrefix"> <summary> Gets and sets the property CNAMEPrefix. <para> If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.Description"> <summary> Gets and sets the property Description. <para> Describes this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> A unique name for the deployment environment. Used in the application URL. </para> <para> Constraint: Must be from 4 to 23 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> <para> Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.OptionsToRemove"> <summary> Gets and sets the property OptionsToRemove. <para> A list of custom user-defined configuration options to remove from the configuration set for this new environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. </para> <para> Condition: You must specify either this or a <code>TemplateName</code>, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.Tags"> <summary> Gets and sets the property Tags. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> <para> Condition: You must specify either this parameter or a <code>SolutionStackName</code>, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.Tier"> <summary> Gets and sets the property Tier. <para> This specifies the tier to use for creating this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentRequest.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The name of the application version to deploy. </para> <para> If the specified application has no associated application versions, AWS Elastic Beanstalk <code>UpdateEnvironment</code> returns an <code>InvalidParameterValue</code> error. </para> <para> Default: If not specified, AWS Elastic Beanstalk attempts to launch the most recently created application version sample application in the container. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse"> <summary> Returns information about the CreateEnvironmentResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResponse.CreateEnvironmentResult"> <summary> Gets and sets the CreateEnvironmentResult property. Represents the output of a CreateEnvironment operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult"> <summary> Describes the properties of an environment. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithCNAME(System.String)"> <summary> Sets the CNAME property </summary> <param name="cNAME">The value to set for the CNAME property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithEndpointURL(System.String)"> <summary> Sets the EndpointURL property </summary> <param name="endpointURL">The value to set for the EndpointURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithHealth(System.String)"> <summary> Sets the Health property </summary> <param name="health">The value to set for the Health property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithResources(Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription)"> <summary> Sets the Resources property </summary> <param name="resources">The value to set for the Resources property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithTier(Amazon.ElasticBeanstalk.Model.EnvironmentTier)"> <summary> Sets the Tier property </summary> <param name="tier">The value to set for the Tier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.CNAME"> <summary> Gets and sets the property CNAME. <para> The URL to the CNAME for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The creation date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The last modified date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.Description"> <summary> Gets and sets the property Description. <para> Describes this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.EndpointURL"> <summary> Gets and sets the property EndpointURL. <para> For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.Health"> <summary> Gets and sets the property Health. <para> Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: </para> <enumValues> <value name="Red"> <para> <code>Red</code> : Indicates the environment is not working. </para> </value> <value name="Yellow"> <para> <code>Yellow</code>: Indicates that something is wrong, the application might not be available, but the instances appear running. </para> </value> <value name="Green"> <para> <code>Green</code>: Indicates the environment is healthy and fully functional. </para> </value> </enumValues> <ul> <li> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. </li> <li> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. </li> <li> <code>Green</code>: Indicates the environment is healthy and fully functional. </li> <li> <code>Grey</code>: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an <code>UpdateEnvironment</code> or <code>RestartEnvironement</code> request. </li> </ul> <para> Default: <code>Grey</code> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.Resources"> <summary> Gets and sets the property Resources. <para> The description of the AWS resources used by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the <code>SolutionStack</code> deployed with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.Status"> <summary> Gets and sets the property Status. <para> The current operational status of the environment: </para> <ul> <li> <code>Launching</code>: Environment is in the process of initial deployment. </li> <li> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version. </li> <li> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate. </li> <li> <code>Terminating</code>: Environment is in the shut-down process. </li> <li> <code>Terminated</code>: Environment is not running. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template used to originally launch this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.Tier"> <summary> Gets and sets the property Tier. <para> Describes the current tier of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateEnvironmentResult.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The application version deployed in this environment. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateStorageLocationRequest"> <summary> Container for the parameters to the CreateStorageLocation operation. Creates the Amazon S3 storage location for the account. <para> This location is used to store user log files. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateStorageLocationResponse"> <summary> Returns information about the CreateStorageLocationResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateStorageLocationResponse.CreateStorageLocationResult"> <summary> Gets and sets the CreateStorageLocationResult property. Represents the output of a CreateStorageLocation operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.CreateStorageLocationResult"> <summary> Results of a <a>CreateStorageLocationResult</a> call. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.CreateStorageLocationResult.WithS3Bucket(System.String)"> <summary> Sets the S3Bucket property </summary> <param name="s3Bucket">The value to set for the S3Bucket property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.CreateStorageLocationResult.S3Bucket"> <summary> Gets and sets the property S3Bucket. <para> The name of the Amazon S3 bucket created. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest"> <summary> Container for the parameters to the DeleteApplication operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest.WithTerminateEnvByForce(System.Boolean)"> <summary> Sets the TerminateEnvByForce property </summary> <param name="terminateEnvByForce">The value to set for the TerminateEnvByForce property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application to delete. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteApplicationRequest.TerminateEnvByForce"> <summary> Gets and sets the property TerminateEnvByForce. <para> When set to true, running environments will be terminated before deleting the application. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteApplicationResponse"> <summary> Returns information about the DeleteApplicationResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest"> <summary> Container for the parameters to the DeleteApplicationVersion operation. Deletes the specified version from the specified application. <note>You cannot delete an application version that is associated with a running environment.</note> </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest.WithDeleteSourceBundle(System.Boolean)"> <summary> Sets the DeleteSourceBundle property </summary> <param name="deleteSourceBundle">The value to set for the DeleteSourceBundle property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application to delete releases from. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest.DeleteSourceBundle"> <summary> Gets and sets the property DeleteSourceBundle. <para> Indicates whether to delete the associated source bundle from Amazon S3: </para> <ul> <li> <code>true</code>: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation. </li> <li> <code>false</code>: No action is taken on the Amazon S3 source bundle specified at time of creation. </li> </ul> <para> Valid Values: <code>true</code> | <code>false</code> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionRequest.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The label of the version to delete. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteApplicationVersionResponse"> <summary> Returns information about the DeleteApplicationVersionResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest"> <summary> Container for the parameters to the DeleteConfigurationTemplate operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application to delete the configuration template from. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template to delete. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteConfigurationTemplateResponse"> <summary> Returns information about the DeleteConfigurationTemplateResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest"> <summary> Container for the parameters to the DeleteEnvironmentConfiguration operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application the environment is associated with. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to delete the draft configuration from. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DeleteEnvironmentConfigurationResponse"> <summary> Returns information about the DeleteEnvironmentConfigurationResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest"> <summary> Container for the parameters to the DescribeApplications operation. Returns the descriptions of existing applications. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest.WithApplicationNames(System.String[])"> <summary> Sets the ApplicationNames property </summary> <param name="applicationNames">The values to add to the ApplicationNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest.WithApplicationNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ApplicationNames property </summary> <param name="applicationNames">The values to add to the ApplicationNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeApplicationsRequest.ApplicationNames"> <summary> Gets and sets the property ApplicationNames. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeApplicationsResponse"> <summary> Returns information about the DescribeApplicationsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeApplicationsResponse.DescribeApplicationsResult"> <summary> Gets and sets the DescribeApplicationsResult property. Represents the output of a DescribeApplications operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeApplicationsResult"> <summary> Result message containing a list of application descriptions. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationsResult.WithApplications(Amazon.ElasticBeanstalk.Model.ApplicationDescription[])"> <summary> Sets the Applications property </summary> <param name="applications">The values to add to the Applications collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationsResult.WithApplications(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ApplicationDescription})"> <summary> Sets the Applications property </summary> <param name="applications">The values to add to the Applications collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeApplicationsResult.Applications"> <summary> Gets and sets the property Applications. <para> This parameter contains a list of <a>ApplicationDescription</a>. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest"> <summary> Container for the parameters to the DescribeApplicationVersions operation. Returns descriptions for existing application versions. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest.WithVersionLabels(System.String[])"> <summary> Sets the VersionLabels property </summary> <param name="versionLabels">The values to add to the VersionLabels collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest.WithVersionLabels(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the VersionLabels property </summary> <param name="versionLabels">The values to add to the VersionLabels collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsRequest.VersionLabels"> <summary> Gets and sets the property VersionLabels. <para> If specified, restricts the returned descriptions to only include ones that have the specified version labels. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsResponse"> <summary> Returns information about the DescribeApplicationVersionsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsResponse.DescribeApplicationVersionsResult"> <summary> Gets and sets the DescribeApplicationVersionsResult property. Represents the output of a DescribeApplicationVersions operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsResult"> <summary> Result message wrapping a list of application version descriptions. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsResult.WithApplicationVersions(Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription[])"> <summary> Sets the ApplicationVersions property </summary> <param name="applicationVersions">The values to add to the ApplicationVersions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsResult.WithApplicationVersions(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription})"> <summary> Sets the ApplicationVersions property </summary> <param name="applicationVersions">The values to add to the ApplicationVersions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeApplicationVersionsResult.ApplicationVersions"> <summary> Gets and sets the property ApplicationVersions. <para> A list of <a>ApplicationVersionDescription</a> . </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest"> <summary> Container for the parameters to the DescribeConfigurationOptions operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.WithOptions(Amazon.ElasticBeanstalk.Model.OptionSpecification[])"> <summary> Sets the Options property </summary> <param name="options">The values to add to the Options collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.WithOptions(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.OptionSpecification})"> <summary> Sets the Options property </summary> <param name="options">The values to add to the Options collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment whose configuration options you want to describe. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.Options"> <summary> Gets and sets the property Options. <para> If specified, restricts the descriptions to only the specified options. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the solution stack whose configuration options you want to describe. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template whose configuration options you want to describe. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResponse"> <summary> Returns information about the DescribeConfigurationOptionsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResponse.DescribeConfigurationOptionsResult"> <summary> Gets and sets the DescribeConfigurationOptionsResult property. Represents the output of a DescribeConfigurationOptions operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResult"> <summary> Describes the settings for a specified configuration set. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResult.WithOptions(Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription[])"> <summary> Sets the Options property </summary> <param name="options">The values to add to the Options collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResult.WithOptions(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionDescription})"> <summary> Sets the Options property </summary> <param name="options">The values to add to the Options collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResult.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResult.Options"> <summary> Gets and sets the property Options. <para> A list of <a>ConfigurationOptionDescription</a>. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationOptionsResult.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the solution stack these configuration options belong to. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest"> <summary> Container for the parameters to the DescribeConfigurationSettings operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The application for the environment or configuration template. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to describe. </para> <para> Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template to describe. </para> <para> Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. If you do not specify either, AWS Elastic Beanstalk returns a <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResponse"> <summary> Returns information about the DescribeConfigurationSettingsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResponse.DescribeConfigurationSettingsResult"> <summary> Gets and sets the DescribeConfigurationSettingsResult property. Represents the output of a DescribeConfigurationSettings operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResult"> <summary> The results from a request to change the configuration settings of an environment. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResult.WithConfigurationSettings(Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription[])"> <summary> Sets the ConfigurationSettings property </summary> <param name="configurationSettings">The values to add to the ConfigurationSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResult.WithConfigurationSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationSettingsDescription})"> <summary> Sets the ConfigurationSettings property </summary> <param name="configurationSettings">The values to add to the ConfigurationSettings collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeConfigurationSettingsResult.ConfigurationSettings"> <summary> Gets and sets the property ConfigurationSettings. <para> A list of <a>ConfigurationSettingsDescription</a>. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest"> <summary> Container for the parameters to the DescribeEnvironmentResources operation. Returns AWS resources for this environment. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the environment to retrieve AWS resource usage data. </para> <para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to retrieve AWS resource usage data. </para> <para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesResponse"> <summary> Returns information about the DescribeEnvironmentResourcesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesResponse.DescribeEnvironmentResourcesResult"> <summary> Gets and sets the DescribeEnvironmentResourcesResult property. Represents the output of a DescribeEnvironmentResources operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesResult"> <summary> Result message containing a list of environment resource descriptions. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesResult.WithEnvironmentResources(Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription)"> <summary> Sets the EnvironmentResources property </summary> <param name="environmentResources">The value to set for the EnvironmentResources property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentResourcesResult.EnvironmentResources"> <summary> Gets and sets the property EnvironmentResources. <para> A list of <a>EnvironmentResourceDescription</a>. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest"> <summary> Container for the parameters to the DescribeEnvironments operation. Returns descriptions for existing environments. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithEnvironmentIds(System.String[])"> <summary> Sets the EnvironmentIds property </summary> <param name="environmentIds">The values to add to the EnvironmentIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithEnvironmentIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the EnvironmentIds property </summary> <param name="environmentIds">The values to add to the EnvironmentIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithEnvironmentNames(System.String[])"> <summary> Sets the EnvironmentNames property </summary> <param name="environmentNames">The values to add to the EnvironmentNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithEnvironmentNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the EnvironmentNames property </summary> <param name="environmentNames">The values to add to the EnvironmentNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithIncludedDeletedBackTo(System.DateTime)"> <summary> Sets the IncludedDeletedBackTo property </summary> <param name="includedDeletedBackTo">The value to set for the IncludedDeletedBackTo property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithIncludeDeleted(System.Boolean)"> <summary> Sets the IncludeDeleted property </summary> <param name="includeDeleted">The value to set for the IncludeDeleted property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.EnvironmentIds"> <summary> Gets and sets the property EnvironmentIds. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.EnvironmentNames"> <summary> Gets and sets the property EnvironmentNames. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.IncludedDeletedBackTo"> <summary> Gets and sets the property IncludedDeletedBackTo. <para> If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.IncludeDeleted"> <summary> Gets and sets the property IncludeDeleted. <para> Indicates whether to include deleted environments: </para> <para> <code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed. </para> <para> <code>false</code>: Do not include deleted environments. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsRequest.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsResponse"> <summary> Returns information about the DescribeEnvironmentsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsResponse.DescribeEnvironmentsResult"> <summary> Gets and sets the DescribeEnvironmentsResult property. Represents the output of a DescribeEnvironments operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsResult"> <summary> Result message containing a list of environment descriptions. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsResult.WithEnvironments(Amazon.ElasticBeanstalk.Model.EnvironmentDescription[])"> <summary> Sets the Environments property </summary> <param name="environments">The values to add to the Environments collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsResult.WithEnvironments(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.EnvironmentDescription})"> <summary> Sets the Environments property </summary> <param name="environments">The values to add to the Environments collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEnvironmentsResult.Environments"> <summary> Gets and sets the property Environments. <para> Returns an <a>EnvironmentDescription</a> list. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest"> <summary> Container for the parameters to the DescribeEvents operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithEndTime(System.DateTime)"> <summary> Sets the EndTime property </summary> <param name="endTime">The value to set for the EndTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithMaxRecords(System.Int32)"> <summary> Sets the MaxRecords property </summary> <param name="maxRecords">The value to set for the MaxRecords property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithRequestId(System.String)"> <summary> Sets the RequestId property </summary> <param name="requestId">The value to set for the RequestId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithSeverity(System.String)"> <summary> Sets the Severity property </summary> <param name="severity">The value to set for the Severity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithStartTime(System.DateTime)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the <code>EndTime</code>. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> Specifies the maximum number of events that can be returned, beginning with the most recent event. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> Pagination token. If specified, the events return the next batch of results. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.RequestId"> <summary> Gets and sets the property RequestId. <para> If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.Severity"> <summary> Gets and sets the property Severity. <para> If specified, limits the events returned from this call to include only those with the specified severity or higher. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsRequest.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEventsResponse"> <summary> Returns information about the DescribeEventsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsResponse.DescribeEventsResult"> <summary> Gets and sets the DescribeEventsResult property. Represents the output of a DescribeEvents operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.DescribeEventsResult"> <summary> Result message wrapping a list of event descriptions. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsResult.WithEvents(Amazon.ElasticBeanstalk.Model.EventDescription[])"> <summary> Sets the Events property </summary> <param name="events">The values to add to the Events collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsResult.WithEvents(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.EventDescription})"> <summary> Sets the Events property </summary> <param name="events">The values to add to the Events collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.DescribeEventsResult.WithNextToken(System.String)"> <summary> Sets the NextToken property </summary> <param name="nextToken">The value to set for the NextToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsResult.Events"> <summary> Gets and sets the property Events. <para> A list of <a>EventDescription</a>. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.DescribeEventsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If returned, this indicates that there are more results to obtain. Use this token in the next <a>DescribeEvents</a> call to get the next batch of events. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.EnvironmentDescription"> <summary> Describes the properties of an environment. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithCNAME(System.String)"> <summary> Sets the CNAME property </summary> <param name="cNAME">The value to set for the CNAME property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithEndpointURL(System.String)"> <summary> Sets the EndpointURL property </summary> <param name="endpointURL">The value to set for the EndpointURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithHealth(System.String)"> <summary> Sets the Health property </summary> <param name="health">The value to set for the Health property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithResources(Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription)"> <summary> Sets the Resources property </summary> <param name="resources">The value to set for the Resources property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithTier(Amazon.ElasticBeanstalk.Model.EnvironmentTier)"> <summary> Sets the Tier property </summary> <param name="tier">The value to set for the Tier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.CNAME"> <summary> Gets and sets the property CNAME. <para> The URL to the CNAME for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The creation date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The last modified date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.Description"> <summary> Gets and sets the property Description. <para> Describes this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.EndpointURL"> <summary> Gets and sets the property EndpointURL. <para> For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.Health"> <summary> Gets and sets the property Health. <para> Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: </para> <enumValues> <value name="Red"> <para> <code>Red</code> : Indicates the environment is not working. </para> </value> <value name="Yellow"> <para> <code>Yellow</code>: Indicates that something is wrong, the application might not be available, but the instances appear running. </para> </value> <value name="Green"> <para> <code>Green</code>: Indicates the environment is healthy and fully functional. </para> </value> </enumValues> <ul> <li> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. </li> <li> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. </li> <li> <code>Green</code>: Indicates the environment is healthy and fully functional. </li> <li> <code>Grey</code>: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an <code>UpdateEnvironment</code> or <code>RestartEnvironement</code> request. </li> </ul> <para> Default: <code>Grey</code> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.Resources"> <summary> Gets and sets the property Resources. <para> The description of the AWS resources used by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the <code>SolutionStack</code> deployed with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.Status"> <summary> Gets and sets the property Status. <para> The current operational status of the environment: </para> <ul> <li> <code>Launching</code>: Environment is in the process of initial deployment. </li> <li> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version. </li> <li> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate. </li> <li> <code>Terminating</code>: Environment is in the shut-down process. </li> <li> <code>Terminated</code>: Environment is not running. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template used to originally launch this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.Tier"> <summary> Gets and sets the property Tier. <para> Describes the current tier of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentDescription.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The application version deployed in this environment. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription"> <summary> The information retrieved from the Amazon EC2 instances. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.WithEc2InstanceId(System.String)"> <summary> Sets the Ec2InstanceId property </summary> <param name="ec2InstanceId">The value to set for the Ec2InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.WithInfoType(System.String)"> <summary> Sets the InfoType property </summary> <param name="infoType">The value to set for the InfoType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.WithSampleTimestamp(System.DateTime)"> <summary> Sets the SampleTimestamp property </summary> <param name="sampleTimestamp">The value to set for the SampleTimestamp property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.Ec2InstanceId"> <summary> Gets and sets the property Ec2InstanceId. <para> The Amazon EC2 Instance ID for this information. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.InfoType"> <summary> Gets and sets the property InfoType. <para> The type of information retrieved. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.Message"> <summary> Gets and sets the property Message. <para> The retrieved information. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription.SampleTimestamp"> <summary> Gets and sets the property SampleTimestamp. <para> The time stamp when this information was retrieved. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription"> <summary> Describes the AWS resources in use by this environment. This data is live. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithAutoScalingGroups(Amazon.ElasticBeanstalk.Model.AutoScalingGroup[])"> <summary> Sets the AutoScalingGroups property </summary> <param name="autoScalingGroups">The values to add to the AutoScalingGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithAutoScalingGroups(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.AutoScalingGroup})"> <summary> Sets the AutoScalingGroups property </summary> <param name="autoScalingGroups">The values to add to the AutoScalingGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithInstances(Amazon.ElasticBeanstalk.Model.Instance[])"> <summary> Sets the Instances property </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.Instance})"> <summary> Sets the Instances property </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithLaunchConfigurations(Amazon.ElasticBeanstalk.Model.LaunchConfiguration[])"> <summary> Sets the LaunchConfigurations property </summary> <param name="launchConfigurations">The values to add to the LaunchConfigurations collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithLaunchConfigurations(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.LaunchConfiguration})"> <summary> Sets the LaunchConfigurations property </summary> <param name="launchConfigurations">The values to add to the LaunchConfigurations collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithLoadBalancers(Amazon.ElasticBeanstalk.Model.LoadBalancer[])"> <summary> Sets the LoadBalancers property </summary> <param name="loadBalancers">The values to add to the LoadBalancers collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithLoadBalancers(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.LoadBalancer})"> <summary> Sets the LoadBalancers property </summary> <param name="loadBalancers">The values to add to the LoadBalancers collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithQueues(Amazon.ElasticBeanstalk.Model.Queue[])"> <summary> Sets the Queues property </summary> <param name="queues">The values to add to the Queues collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithQueues(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.Queue})"> <summary> Sets the Queues property </summary> <param name="queues">The values to add to the Queues collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithTriggers(Amazon.ElasticBeanstalk.Model.Trigger[])"> <summary> Sets the Triggers property </summary> <param name="triggers">The values to add to the Triggers collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.WithTriggers(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.Trigger})"> <summary> Sets the Triggers property </summary> <param name="triggers">The values to add to the Triggers collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.AutoScalingGroups"> <summary> Gets and sets the property AutoScalingGroups. <para> The <code>AutoScalingGroups</code> used by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.Instances"> <summary> Gets and sets the property Instances. <para> The Amazon EC2 instances used by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.LaunchConfigurations"> <summary> Gets and sets the property LaunchConfigurations. <para> The Auto Scaling launch configurations in use by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.LoadBalancers"> <summary> Gets and sets the property LoadBalancers. <para> The LoadBalancers in use by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.Queues"> <summary> Gets and sets the property Queues. <para> The queues used by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourceDescription.Triggers"> <summary> Gets and sets the property Triggers. <para> The <code>AutoScaling</code> triggers in use by this environment. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription"> <summary> Describes the AWS resources in use by this environment. This data is not live data. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription.WithLoadBalancer(Amazon.ElasticBeanstalk.Model.LoadBalancerDescription)"> <summary> Sets the LoadBalancer property </summary> <param name="loadBalancer">The value to set for the LoadBalancer property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription.LoadBalancer"> <summary> Gets and sets the property LoadBalancer. <para> Describes the LoadBalancer. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.EnvironmentTier"> <summary> Describes the properties of an environment tier </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentTier.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentTier.WithType(System.String)"> <summary> Sets the Type property </summary> <param name="type">The value to set for the Type property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EnvironmentTier.WithVersion(System.String)"> <summary> Sets the Version property </summary> <param name="version">The value to set for the Version property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentTier.Name"> <summary> Gets and sets the property Name. <para> The name of this environment tier. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentTier.Type"> <summary> Gets and sets the property Type. <para> The type of this environment tier. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EnvironmentTier.Version"> <summary> Gets and sets the property Version. <para> The version of this environment tier. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.EventDescription"> <summary> Describes an event. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithEventDate(System.DateTime)"> <summary> Sets the EventDate property </summary> <param name="eventDate">The value to set for the EventDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithRequestId(System.String)"> <summary> Sets the RequestId property </summary> <param name="requestId">The value to set for the RequestId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithSeverity(System.String)"> <summary> Sets the Severity property </summary> <param name="severity">The value to set for the Severity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.EventDescription.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The application associated with the event. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment associated with this event. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.EventDate"> <summary> Gets and sets the property EventDate. <para> The date when the event occurred. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.Message"> <summary> Gets and sets the property Message. <para> The event message. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.RequestId"> <summary> Gets and sets the property RequestId. <para> The web service request ID for the activity of this event. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.Severity"> <summary> Gets and sets the property Severity. <para> The severity level of this event. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration associated with this event. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.EventDescription.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The release label for the application version associated with this event. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Instance"> <summary> The description of an Amazon EC2 instance. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Instance.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Instance.Id"> <summary> Gets and sets the property Id. <para> The ID of the Amazon EC2 instance. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.InsufficientPrivilegesException.#ctor(System.String)"> <summary> Constructs a new InsufficientPrivilegesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ApplicationDescriptionUnmarshaller"> <summary> Response Unmarshaller for ApplicationDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ApplicationVersionDescriptionUnmarshaller"> <summary> Response Unmarshaller for ApplicationVersionDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.AutoScalingGroupUnmarshaller"> <summary> Response Unmarshaller for AutoScalingGroup Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CheckDNSAvailabilityRequestMarshaller"> <summary> CheckDNSAvailability Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CheckDNSAvailabilityResponseUnmarshaller"> <summary> Response Unmarshaller for CheckDNSAvailability operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CheckDNSAvailabilityResultUnmarshaller"> <summary> Response Unmarshaller for CheckDNSAvailability Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ConfigurationOptionDescriptionUnmarshaller"> <summary> Response Unmarshaller for ConfigurationOptionDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ConfigurationOptionSettingUnmarshaller"> <summary> Response Unmarshaller for ConfigurationOptionSetting Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ConfigurationSettingsDescriptionUnmarshaller"> <summary> Response Unmarshaller for ConfigurationSettingsDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateApplicationRequestMarshaller"> <summary> CreateApplication Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateApplicationResponseUnmarshaller"> <summary> Response Unmarshaller for CreateApplication operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateApplicationResultUnmarshaller"> <summary> Response Unmarshaller for CreateApplication Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateApplicationVersionRequestMarshaller"> <summary> CreateApplicationVersion Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateApplicationVersionResponseUnmarshaller"> <summary> Response Unmarshaller for CreateApplicationVersion operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateApplicationVersionResultUnmarshaller"> <summary> Response Unmarshaller for CreateApplicationVersion Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateConfigurationTemplateRequestMarshaller"> <summary> CreateConfigurationTemplate Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateConfigurationTemplateResponseUnmarshaller"> <summary> Response Unmarshaller for CreateConfigurationTemplate operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateConfigurationTemplateResultUnmarshaller"> <summary> Response Unmarshaller for CreateConfigurationTemplate Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateEnvironmentRequestMarshaller"> <summary> CreateEnvironment Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateEnvironmentResponseUnmarshaller"> <summary> Response Unmarshaller for CreateEnvironment operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateEnvironmentResultUnmarshaller"> <summary> Response Unmarshaller for CreateEnvironment Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateStorageLocationRequestMarshaller"> <summary> CreateStorageLocation Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateStorageLocationResponseUnmarshaller"> <summary> Response Unmarshaller for CreateStorageLocation operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.CreateStorageLocationResultUnmarshaller"> <summary> Response Unmarshaller for CreateStorageLocation Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteApplicationRequestMarshaller"> <summary> DeleteApplication Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteApplicationResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteApplication operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteApplicationVersionRequestMarshaller"> <summary> DeleteApplicationVersion Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteApplicationVersionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteApplicationVersion operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteConfigurationTemplateRequestMarshaller"> <summary> DeleteConfigurationTemplate Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteConfigurationTemplateResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteConfigurationTemplate operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteEnvironmentConfigurationRequestMarshaller"> <summary> DeleteEnvironmentConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DeleteEnvironmentConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteEnvironmentConfiguration operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeApplicationsRequestMarshaller"> <summary> DescribeApplications Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeApplicationsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeApplications operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeApplicationsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeApplications Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeApplicationVersionsRequestMarshaller"> <summary> DescribeApplicationVersions Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeApplicationVersionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeApplicationVersions operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeApplicationVersionsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeApplicationVersions Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeConfigurationOptionsRequestMarshaller"> <summary> DescribeConfigurationOptions Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeConfigurationOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigurationOptions operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeConfigurationOptionsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigurationOptions Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeConfigurationSettingsRequestMarshaller"> <summary> DescribeConfigurationSettings Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeConfigurationSettingsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigurationSettings operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeConfigurationSettingsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigurationSettings Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEnvironmentResourcesRequestMarshaller"> <summary> DescribeEnvironmentResources Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEnvironmentResourcesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeEnvironmentResources operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEnvironmentResourcesResultUnmarshaller"> <summary> Response Unmarshaller for DescribeEnvironmentResources Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEnvironmentsRequestMarshaller"> <summary> DescribeEnvironments Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEnvironmentsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeEnvironments operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEnvironmentsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeEnvironments Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEventsRequestMarshaller"> <summary> DescribeEvents Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEventsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeEvents operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.DescribeEventsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeEvents Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.EnvironmentDescriptionUnmarshaller"> <summary> Response Unmarshaller for EnvironmentDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.EnvironmentInfoDescriptionUnmarshaller"> <summary> Response Unmarshaller for EnvironmentInfoDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.EnvironmentResourceDescriptionUnmarshaller"> <summary> Response Unmarshaller for EnvironmentResourceDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.EnvironmentResourcesDescriptionUnmarshaller"> <summary> Response Unmarshaller for EnvironmentResourcesDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.EnvironmentTierUnmarshaller"> <summary> Response Unmarshaller for EnvironmentTier Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.EventDescriptionUnmarshaller"> <summary> Response Unmarshaller for EventDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.InstanceUnmarshaller"> <summary> Response Unmarshaller for Instance Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.LaunchConfigurationUnmarshaller"> <summary> Response Unmarshaller for LaunchConfiguration Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ListAvailableSolutionStacksRequestMarshaller"> <summary> ListAvailableSolutionStacks Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ListAvailableSolutionStacksResponseUnmarshaller"> <summary> Response Unmarshaller for ListAvailableSolutionStacks operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ListAvailableSolutionStacksResultUnmarshaller"> <summary> Response Unmarshaller for ListAvailableSolutionStacks Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ListenerUnmarshaller"> <summary> Response Unmarshaller for Listener Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.LoadBalancerDescriptionUnmarshaller"> <summary> Response Unmarshaller for LoadBalancerDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.LoadBalancerUnmarshaller"> <summary> Response Unmarshaller for LoadBalancer Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.OptionRestrictionRegexUnmarshaller"> <summary> Response Unmarshaller for OptionRestrictionRegex Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.QueueUnmarshaller"> <summary> Response Unmarshaller for Queue Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RebuildEnvironmentRequestMarshaller"> <summary> RebuildEnvironment Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RebuildEnvironmentResponseUnmarshaller"> <summary> Response Unmarshaller for RebuildEnvironment operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RequestEnvironmentInfoRequestMarshaller"> <summary> RequestEnvironmentInfo Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RequestEnvironmentInfoResponseUnmarshaller"> <summary> Response Unmarshaller for RequestEnvironmentInfo operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RestartAppServerRequestMarshaller"> <summary> RestartAppServer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RestartAppServerResponseUnmarshaller"> <summary> Response Unmarshaller for RestartAppServer operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RetrieveEnvironmentInfoRequestMarshaller"> <summary> RetrieveEnvironmentInfo Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RetrieveEnvironmentInfoResponseUnmarshaller"> <summary> Response Unmarshaller for RetrieveEnvironmentInfo operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.RetrieveEnvironmentInfoResultUnmarshaller"> <summary> Response Unmarshaller for RetrieveEnvironmentInfo Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.S3LocationUnmarshaller"> <summary> Response Unmarshaller for S3Location Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.SolutionStackDescriptionUnmarshaller"> <summary> Response Unmarshaller for SolutionStackDescription Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.SwapEnvironmentCNAMEsRequestMarshaller"> <summary> SwapEnvironmentCNAMEs Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.SwapEnvironmentCNAMEsResponseUnmarshaller"> <summary> Response Unmarshaller for SwapEnvironmentCNAMEs operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.TerminateEnvironmentRequestMarshaller"> <summary> TerminateEnvironment Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.TerminateEnvironmentResponseUnmarshaller"> <summary> Response Unmarshaller for TerminateEnvironment operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.TerminateEnvironmentResultUnmarshaller"> <summary> Response Unmarshaller for TerminateEnvironment Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.TriggerUnmarshaller"> <summary> Response Unmarshaller for Trigger Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateApplicationRequestMarshaller"> <summary> UpdateApplication Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateApplicationResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateApplication operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateApplicationResultUnmarshaller"> <summary> Response Unmarshaller for UpdateApplication Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateApplicationVersionRequestMarshaller"> <summary> UpdateApplicationVersion Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateApplicationVersionResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateApplicationVersion operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateApplicationVersionResultUnmarshaller"> <summary> Response Unmarshaller for UpdateApplicationVersion Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateConfigurationTemplateRequestMarshaller"> <summary> UpdateConfigurationTemplate Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateConfigurationTemplateResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateConfigurationTemplate operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateConfigurationTemplateResultUnmarshaller"> <summary> Response Unmarshaller for UpdateConfigurationTemplate Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateEnvironmentRequestMarshaller"> <summary> UpdateEnvironment Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateEnvironmentResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateEnvironment operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.UpdateEnvironmentResultUnmarshaller"> <summary> Response Unmarshaller for UpdateEnvironment Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ValidateConfigurationSettingsRequestMarshaller"> <summary> ValidateConfigurationSettings Request Marshaller </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ValidateConfigurationSettingsResponseUnmarshaller"> <summary> Response Unmarshaller for ValidateConfigurationSettings operation </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ValidateConfigurationSettingsResultUnmarshaller"> <summary> Response Unmarshaller for ValidateConfigurationSettings Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Internal.MarshallTransformations.ValidationMessageUnmarshaller"> <summary> Response Unmarshaller for ValidationMessage Object </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.InvalidParameterCombinationException"> <summary> AmazonElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.InvalidParameterCombinationException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterCombinationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.InvalidParameterValueException"> <summary> AmazonElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.InvalidParameterValueException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterValueException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.LaunchConfiguration"> <summary> Describes an Auto Scaling launch configuration. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.LaunchConfiguration.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.LaunchConfiguration.Name"> <summary> Gets and sets the property Name. <para> The name of the launch configuration. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksRequest"> <summary> Container for the parameters to the ListAvailableSolutionStacks operation. Returns a list of the available solution stack names. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResponse"> <summary> Returns information about the ListAvailableSolutionStacksResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResponse.ListAvailableSolutionStacksResult"> <summary> Gets and sets the ListAvailableSolutionStacksResult property. Represents the output of a ListAvailableSolutionStacks operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResult"> <summary> A list of available AWS Elastic Beanstalk solution stacks. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResult.WithSolutionStackDetails(Amazon.ElasticBeanstalk.Model.SolutionStackDescription[])"> <summary> Sets the SolutionStackDetails property </summary> <param name="solutionStackDetails">The values to add to the SolutionStackDetails collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResult.WithSolutionStackDetails(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.SolutionStackDescription})"> <summary> Sets the SolutionStackDetails property </summary> <param name="solutionStackDetails">The values to add to the SolutionStackDetails collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResult.WithSolutionStacks(System.String[])"> <summary> Sets the SolutionStacks property </summary> <param name="solutionStacks">The values to add to the SolutionStacks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResult.WithSolutionStacks(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the SolutionStacks property </summary> <param name="solutionStacks">The values to add to the SolutionStacks collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResult.SolutionStackDetails"> <summary> Gets and sets the property SolutionStackDetails. <para> A list of available solution stacks and their <a>SolutionStackDescription</a>. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ListAvailableSolutionStacksResult.SolutionStacks"> <summary> Gets and sets the property SolutionStacks. <para> A list of available solution stacks. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Listener"> <summary> Describes the properties of a Listener for the LoadBalancer. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Listener.WithPort(System.Int32)"> <summary> Sets the Port property </summary> <param name="port">The value to set for the Port property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Listener.WithProtocol(System.String)"> <summary> Sets the Protocol property </summary> <param name="protocol">The value to set for the Protocol property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Listener.Port"> <summary> Gets and sets the property Port. <para> The port that is used by the Listener. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Listener.Protocol"> <summary> Gets and sets the property Protocol. <para> The protocol that is used by the Listener. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.LoadBalancer"> <summary> Describes a LoadBalancer. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.LoadBalancer.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.LoadBalancer.Name"> <summary> Gets and sets the property Name. <para> The name of the LoadBalancer. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription"> <summary> Describes the details of a LoadBalancer. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription.WithDomain(System.String)"> <summary> Sets the Domain property </summary> <param name="domain">The value to set for the Domain property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription.WithListeners(Amazon.ElasticBeanstalk.Model.Listener[])"> <summary> Sets the Listeners property </summary> <param name="listeners">The values to add to the Listeners collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription.WithListeners(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.Listener})"> <summary> Sets the Listeners property </summary> <param name="listeners">The values to add to the Listeners collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription.Domain"> <summary> Gets and sets the property Domain. <para> The domain name of the LoadBalancer. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription.Listeners"> <summary> Gets and sets the property Listeners. <para> A list of Listeners used by the LoadBalancer. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.LoadBalancerDescription.LoadBalancerName"> <summary> Gets and sets the property LoadBalancerName. <para> The name of the LoadBalancer. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.MissingRequiredParameterException"> <summary> AmazonElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.MissingRequiredParameterException.#ctor(System.String)"> <summary> Constructs a new MissingRequiredParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.OperationInProgressException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.OperationInProgressException.#ctor(System.String)"> <summary> Constructs a new OperationInProgressException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.OptionRestrictionRegex"> <summary> A regular expression representing a restriction on a string configuration option value. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.OptionRestrictionRegex.WithLabel(System.String)"> <summary> Sets the Label property </summary> <param name="label">The value to set for the Label property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.OptionRestrictionRegex.WithPattern(System.String)"> <summary> Sets the Pattern property </summary> <param name="pattern">The value to set for the Pattern property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.OptionRestrictionRegex.Label"> <summary> Gets and sets the property Label. <para> A unique name representing this regular expression. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.OptionRestrictionRegex.Pattern"> <summary> Gets and sets the property Pattern. <para> The regular expression pattern that a string configuration option value with this restriction must match. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.OptionSpecification"> <summary> A specification identifying an individual configuration option. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.OptionSpecification.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="ns">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.OptionSpecification.WithOptionName(System.String)"> <summary> Sets the OptionName property </summary> <param name="optionName">The value to set for the OptionName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.OptionSpecification.Namespace"> <summary> Gets and sets the property Namespace. <para> A unique namespace identifying the option's associated AWS resource. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.OptionSpecification.OptionName"> <summary> Gets and sets the property OptionName. <para> The name of the configuration option. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Queue"> <summary> Describes a queue. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Queue.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Queue.WithURL(System.String)"> <summary> Sets the URL property </summary> <param name="uRL">The value to set for the URL property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Queue.Name"> <summary> Gets and sets the property Name. <para> The name of the queue. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Queue.URL"> <summary> Gets and sets the property URL. <para> The URL of the queue. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest"> <summary> Container for the parameters to the RebuildEnvironment operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the environment to rebuild. </para> <para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RebuildEnvironmentRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to rebuild. </para> <para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RebuildEnvironmentResponse"> <summary> Returns information about the RebuildEnvironmentResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest"> <summary> Container for the parameters to the RequestEnvironmentInfo operation. 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. Use <a>RetrieveEnvironmentInfo</a> to access the compiled information. </para> <para> Related Topics </para> <ul> <li> <a>RetrieveEnvironmentInfo</a> </li> </ul> </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest.WithInfoType(System.String)"> <summary> Sets the InfoType property </summary> <param name="infoType">The value to set for the InfoType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the environment of the requested data. </para> <para> If no such environment is found, <code>RequestEnvironmentInfo</code> returns an <code>InvalidParameterValue</code> error. </para> <para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment of the requested data. </para> <para> If no such environment is found, <code>RequestEnvironmentInfo</code> returns an <code>InvalidParameterValue</code> error. </para> <para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoRequest.InfoType"> <summary> Gets and sets the property InfoType. <para> The type of information to request. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RequestEnvironmentInfoResponse"> <summary> Returns information about the RequestEnvironmentInfoResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RestartAppServerRequest"> <summary> Container for the parameters to the RestartAppServer operation. Causes the environment to restart the application container server running on each Amazon EC2 instance. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RestartAppServerRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RestartAppServerRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RestartAppServerRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the environment to restart the server for. </para> <para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RestartAppServerRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to restart the server for. </para> <para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RestartAppServerResponse"> <summary> Returns information about the RestartAppServerResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest"> <summary> Container for the parameters to the RetrieveEnvironmentInfo operation. Retrieves the compiled information from a <a>RequestEnvironmentInfo</a> request. <para> Related Topics </para> <ul> <li> <a>RequestEnvironmentInfo</a> </li> </ul> </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest.WithInfoType(System.String)"> <summary> Sets the InfoType property </summary> <param name="infoType">The value to set for the InfoType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the data's environment. </para> <para> If no such environment is found, returns an <code>InvalidParameterValue</code> error. </para> <para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the data's environment. </para> <para> If no such environment is found, returns an <code>InvalidParameterValue</code> error. </para> <para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoRequest.InfoType"> <summary> Gets and sets the property InfoType. <para> The type of information to retrieve. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoResponse"> <summary> Returns information about the RetrieveEnvironmentInfoResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoResponse.RetrieveEnvironmentInfoResult"> <summary> Gets and sets the RetrieveEnvironmentInfoResult property. Represents the output of a RetrieveEnvironmentInfo operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoResult"> <summary> Result message containing a description of the requested environment info. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoResult.WithEnvironmentInfo(Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription[])"> <summary> Sets the EnvironmentInfo property </summary> <param name="environmentInfo">The values to add to the EnvironmentInfo collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoResult.WithEnvironmentInfo(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.EnvironmentInfoDescription})"> <summary> Sets the EnvironmentInfo property </summary> <param name="environmentInfo">The values to add to the EnvironmentInfo collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.RetrieveEnvironmentInfoResult.EnvironmentInfo"> <summary> Gets and sets the property EnvironmentInfo. <para> The <a>EnvironmentInfoDescription</a> of the environment. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.S3Location"> <summary> A specification of a location in Amazon S3. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.S3Location.WithS3Bucket(System.String)"> <summary> Sets the S3Bucket property </summary> <param name="s3Bucket">The value to set for the S3Bucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.S3Location.WithS3Key(System.String)"> <summary> Sets the S3Key property </summary> <param name="s3Key">The value to set for the S3Key property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.S3Location.S3Bucket"> <summary> Gets and sets the property S3Bucket. <para> The Amazon S3 bucket where the data is located. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.S3Location.S3Key"> <summary> Gets and sets the property S3Key. <para> The Amazon S3 key where the data is located. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.S3LocationNotInServiceRegionException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.S3LocationNotInServiceRegionException.#ctor(System.String)"> <summary> Constructs a new S3LocationNotInServiceRegionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.S3SubscriptionRequiredException.#ctor(System.String)"> <summary> Constructs a new S3SubscriptionRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.SolutionStackDescription"> <summary> Describes the solution stack. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SolutionStackDescription.WithPermittedFileTypes(System.String[])"> <summary> Sets the PermittedFileTypes property </summary> <param name="permittedFileTypes">The values to add to the PermittedFileTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SolutionStackDescription.WithPermittedFileTypes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the PermittedFileTypes property </summary> <param name="permittedFileTypes">The values to add to the PermittedFileTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SolutionStackDescription.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SolutionStackDescription.PermittedFileTypes"> <summary> Gets and sets the property PermittedFileTypes. <para> The permitted file types allowed for a solution stack. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SolutionStackDescription.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the solution stack. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.SourceBundleDeletionException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SourceBundleDeletionException.#ctor(System.String)"> <summary> Constructs a new SourceBundleDeletionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.SourceConfiguration"> <summary> A specification for an environment configuration </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SourceConfiguration.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SourceConfiguration.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SourceConfiguration.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with the configuration. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SourceConfiguration.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest"> <summary> Container for the parameters to the SwapEnvironmentCNAMEs operation. Swaps the CNAMEs of two environments. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.WithDestinationEnvironmentId(System.String)"> <summary> Sets the DestinationEnvironmentId property </summary> <param name="destinationEnvironmentId">The value to set for the DestinationEnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.WithDestinationEnvironmentName(System.String)"> <summary> Sets the DestinationEnvironmentName property </summary> <param name="destinationEnvironmentName">The value to set for the DestinationEnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.WithSourceEnvironmentId(System.String)"> <summary> Sets the SourceEnvironmentId property </summary> <param name="sourceEnvironmentId">The value to set for the SourceEnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.WithSourceEnvironmentName(System.String)"> <summary> Sets the SourceEnvironmentName property </summary> <param name="sourceEnvironmentName">The value to set for the SourceEnvironmentName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.DestinationEnvironmentId"> <summary> Gets and sets the property DestinationEnvironmentId. <para> The ID of the destination environment. </para> <para> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentId</code> with the <code>DestinationEnvironmentId</code>. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.DestinationEnvironmentName"> <summary> Gets and sets the property DestinationEnvironmentName. <para> The name of the destination environment. </para> <para> Condition: You must specify at least the <code>DestinationEnvironmentID</code> or the <code>DestinationEnvironmentName</code>. You may also specify both. You must specify the <code>SourceEnvironmentName</code> with the <code>DestinationEnvironmentName</code>. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.SourceEnvironmentId"> <summary> Gets and sets the property SourceEnvironmentId. <para> The ID of the source environment. </para> <para> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentId</code>, you must specify the <code>DestinationEnvironmentId</code>. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsRequest.SourceEnvironmentName"> <summary> Gets and sets the property SourceEnvironmentName. <para> The name of the source environment. </para> <para> Condition: You must specify at least the <code>SourceEnvironmentID</code> or the <code>SourceEnvironmentName</code>. You may also specify both. If you specify the <code>SourceEnvironmentName</code>, you must specify the <code>DestinationEnvironmentName</code>. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.SwapEnvironmentCNAMEsResponse"> <summary> Returns information about the SwapEnvironmentCNAMEsResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Tag"> <summary> </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Tag.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Tag.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Tag.Key"> <summary> Gets and sets the property Key. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Tag.Value"> <summary> Gets and sets the property Value. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest"> <summary> Container for the parameters to the TerminateEnvironment operation. Terminates the specified environment. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest.WithTerminateResources(System.Boolean)"> <summary> Sets the TerminateResources property </summary> <param name="terminateResources">The value to set for the TerminateResources property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the environment to terminate. </para> <para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to terminate. </para> <para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentRequest.TerminateResources"> <summary> Gets and sets the property TerminateResources. <para> Indicates whether the associated AWS resources should shut down when the environment is terminated: </para> <enumValues> <value name="true"> <para> <code>true</code>: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </para> </value> <value name="false"> <para> <code>false</code>: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </para> </value> </enumValues> <ul> <li> <code>true</code>: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. </li> <li> <code>false</code>: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate. </li> </ul> <para> For more information, see the <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/ug/"> AWS Elastic Beanstalk User Guide. </a> </para> <para> Default: <code>true</code> </para> <para> Valid Values: <code>true</code> | <code>false</code> </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResponse"> <summary> Returns information about the TerminateEnvironmentResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResponse.TerminateEnvironmentResult"> <summary> Gets and sets the TerminateEnvironmentResult property. Represents the output of a TerminateEnvironment operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult"> <summary> Describes the properties of an environment. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithCNAME(System.String)"> <summary> Sets the CNAME property </summary> <param name="cNAME">The value to set for the CNAME property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithEndpointURL(System.String)"> <summary> Sets the EndpointURL property </summary> <param name="endpointURL">The value to set for the EndpointURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithHealth(System.String)"> <summary> Sets the Health property </summary> <param name="health">The value to set for the Health property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithResources(Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription)"> <summary> Sets the Resources property </summary> <param name="resources">The value to set for the Resources property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithTier(Amazon.ElasticBeanstalk.Model.EnvironmentTier)"> <summary> Sets the Tier property </summary> <param name="tier">The value to set for the Tier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.CNAME"> <summary> Gets and sets the property CNAME. <para> The URL to the CNAME for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The creation date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The last modified date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.Description"> <summary> Gets and sets the property Description. <para> Describes this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.EndpointURL"> <summary> Gets and sets the property EndpointURL. <para> For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.Health"> <summary> Gets and sets the property Health. <para> Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: </para> <enumValues> <value name="Red"> <para> <code>Red</code> : Indicates the environment is not working. </para> </value> <value name="Yellow"> <para> <code>Yellow</code>: Indicates that something is wrong, the application might not be available, but the instances appear running. </para> </value> <value name="Green"> <para> <code>Green</code>: Indicates the environment is healthy and fully functional. </para> </value> </enumValues> <ul> <li> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. </li> <li> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. </li> <li> <code>Green</code>: Indicates the environment is healthy and fully functional. </li> <li> <code>Grey</code>: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an <code>UpdateEnvironment</code> or <code>RestartEnvironement</code> request. </li> </ul> <para> Default: <code>Grey</code> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.Resources"> <summary> Gets and sets the property Resources. <para> The description of the AWS resources used by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the <code>SolutionStack</code> deployed with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.Status"> <summary> Gets and sets the property Status. <para> The current operational status of the environment: </para> <ul> <li> <code>Launching</code>: Environment is in the process of initial deployment. </li> <li> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version. </li> <li> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate. </li> <li> <code>Terminating</code>: Environment is in the shut-down process. </li> <li> <code>Terminated</code>: Environment is not running. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template used to originally launch this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.Tier"> <summary> Gets and sets the property Tier. <para> Describes the current tier of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.TerminateEnvironmentResult.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The application version deployed in this environment. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationsException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TooManyApplicationsException.#ctor(System.String)"> <summary> Constructs a new TooManyApplicationsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TooManyApplicationVersionsException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TooManyApplicationVersionsException.#ctor(System.String)"> <summary> Constructs a new TooManyApplicationVersionsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TooManyBucketsException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TooManyBucketsException.#ctor(System.String)"> <summary> Constructs a new TooManyBucketsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TooManyConfigurationTemplatesException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TooManyConfigurationTemplatesException.#ctor(System.String)"> <summary> Constructs a new TooManyConfigurationTemplatesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException"> <summary> ElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.TooManyEnvironmentsException.#ctor(System.String)"> <summary> Constructs a new TooManyEnvironmentsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.Trigger"> <summary> Describes a trigger. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.Trigger.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.Trigger.Name"> <summary> Gets and sets the property Name. <para> The name of the trigger. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest"> <summary> Container for the parameters to the UpdateApplication operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application to update. If no such application is found, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationRequest.Description"> <summary> Gets and sets the property Description. <para> A new description for the application. </para> <para> Default: If not specified, AWS Elastic Beanstalk does not update the description. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateApplicationResponse"> <summary> Returns information about the UpdateApplicationResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationResponse.UpdateApplicationResult"> <summary> Gets and sets the UpdateApplicationResult property. Represents the output of a UpdateApplication operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateApplicationResult"> <summary> Result message containing a single description of an application. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateApplicationResult.WithApplication(Amazon.ElasticBeanstalk.Model.ApplicationDescription)"> <summary> Sets the Application property </summary> <param name="application">The value to set for the Application property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationResult.Application"> <summary> Gets and sets the property Application. <para> The <a>ApplicationDescription</a> of the application. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest"> <summary> Container for the parameters to the UpdateApplicationVersion operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this version. </para> <para> If no application is found with this name, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest.Description"> <summary> Gets and sets the property Description. <para> A new description for this release. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionRequest.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The name of the version to update. </para> <para> If no application version is found with this label, <code>UpdateApplication</code> returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionResponse"> <summary> Returns information about the UpdateApplicationVersionResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionResponse.UpdateApplicationVersionResult"> <summary> Gets and sets the UpdateApplicationVersionResult property. Represents the output of a UpdateApplicationVersion operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionResult"> <summary> Result message wrapping a single description of an application version. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionResult.WithApplicationVersion(Amazon.ElasticBeanstalk.Model.ApplicationVersionDescription)"> <summary> Sets the ApplicationVersion property </summary> <param name="applicationVersion">The value to set for the ApplicationVersion property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateApplicationVersionResult.ApplicationVersion"> <summary> Gets and sets the property ApplicationVersion. <para> The <a>ApplicationVersionDescription</a> of the application version. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest"> <summary> Container for the parameters to the UpdateConfigurationTemplate operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.WithOptionsToRemove(Amazon.ElasticBeanstalk.Model.OptionSpecification[])"> <summary> Sets the OptionsToRemove property </summary> <param name="optionsToRemove">The values to add to the OptionsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.WithOptionsToRemove(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.OptionSpecification})"> <summary> Sets the OptionsToRemove property </summary> <param name="optionsToRemove">The values to add to the OptionsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with the configuration template to update. </para> <para> If no application is found with this name, <code>UpdateConfigurationTemplate</code> returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.Description"> <summary> Gets and sets the property Description. <para> A new description for the configuration. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> A list of configuration option settings to update with the new specified option value. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.OptionsToRemove"> <summary> Gets and sets the property OptionsToRemove. <para> A list of configuration options to remove from the configuration set. </para> <para> Constraint: You can remove only <code>UserDefined</code> configuration options. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template to update. </para> <para> If no configuration template is found with this name, <code>UpdateConfigurationTemplate</code> returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResponse"> <summary> Returns information about the UpdateConfigurationTemplateResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResponse.UpdateConfigurationTemplateResult"> <summary> Gets and sets the UpdateConfigurationTemplateResult property. Represents the output of a UpdateConfigurationTemplate operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult"> <summary> Describes the settings for a configuration set. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithDeploymentStatus(System.String)"> <summary> Sets the DeploymentStatus property </summary> <param name="deploymentStatus">The value to set for the DeploymentStatus property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The date (in UTC time) when this configuration set was created. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The date (in UTC time) when this configuration set was last modified. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.DeploymentStatus"> <summary> Gets and sets the property DeploymentStatus. <para> If this configuration set is associated with an environment, the <code>DeploymentStatus</code> parameter indicates the deployment status of this configuration set: </para> <enumValues> <value name="null"> <para> <code>null</code>: This configuration is not associated with a running environment. </para> </value> <value name="pending"> <para> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. </para> </value> <value name="deployed"> <para> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment. </para> </value> <value name="failed"> <para> <code>failed</code>: This is a draft configuration, that failed to successfully deploy. </para> </value> </enumValues> <ul> <li> <code>null</code>: This configuration is not associated with a running environment. </li> <li> <code>pending</code>: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. </li> <li> <code>deployed</code>: This is the configuration that is currently deployed to the associated running environment. </li> <li> <code>failed</code>: This is a draft configuration that failed to successfully deploy. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.Description"> <summary> Gets and sets the property Description. <para> Describes this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> If not <code>null</code>, the name of the environment for this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> A list of the configuration options and their values in this configuration set. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the solution stack this configuration set uses. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateConfigurationTemplateResult.TemplateName"> <summary> Gets and sets the property TemplateName. <para> If not <code>null</code>, the name of the configuration template for this configuration set. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest"> <summary> Container for the parameters to the UpdateEnvironment operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithOptionsToRemove(Amazon.ElasticBeanstalk.Model.OptionSpecification[])"> <summary> Sets the OptionsToRemove property </summary> <param name="optionsToRemove">The values to add to the OptionsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithOptionsToRemove(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.OptionSpecification})"> <summary> Sets the OptionsToRemove property </summary> <param name="optionsToRemove">The values to add to the OptionsToRemove collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithTier(Amazon.ElasticBeanstalk.Model.EnvironmentTier)"> <summary> Sets the Tier property </summary> <param name="tier">The value to set for the Tier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.Description"> <summary> Gets and sets the property Description. <para> If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of the environment to update. </para> <para> If no environment with this ID exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> <para> Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> <para> Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.OptionsToRemove"> <summary> Gets and sets the property OptionsToRemove. <para> A list of custom user-defined configuration options to remove from the configuration set for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.Tier"> <summary> Gets and sets the property Tier. <para> This specifies the tier to use to update the environment. </para> <para> Condition: You can only update the tier version for an environment. If you change the name of the type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentRequest.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an <code>InvalidParameterValue</code> error. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResponse"> <summary> Returns information about the UpdateEnvironmentResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResponse.UpdateEnvironmentResult"> <summary> Gets and sets the UpdateEnvironmentResult property. Represents the output of a UpdateEnvironment operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult"> <summary> Describes the properties of an environment. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithCNAME(System.String)"> <summary> Sets the CNAME property </summary> <param name="cNAME">The value to set for the CNAME property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithDateCreated(System.DateTime)"> <summary> Sets the DateCreated property </summary> <param name="dateCreated">The value to set for the DateCreated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithDateUpdated(System.DateTime)"> <summary> Sets the DateUpdated property </summary> <param name="dateUpdated">The value to set for the DateUpdated property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithEndpointURL(System.String)"> <summary> Sets the EndpointURL property </summary> <param name="endpointURL">The value to set for the EndpointURL property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithEnvironmentId(System.String)"> <summary> Sets the EnvironmentId property </summary> <param name="environmentId">The value to set for the EnvironmentId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithHealth(System.String)"> <summary> Sets the Health property </summary> <param name="health">The value to set for the Health property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithResources(Amazon.ElasticBeanstalk.Model.EnvironmentResourcesDescription)"> <summary> Sets the Resources property </summary> <param name="resources">The value to set for the Resources property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithSolutionStackName(System.String)"> <summary> Sets the SolutionStackName property </summary> <param name="solutionStackName">The value to set for the SolutionStackName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithTier(Amazon.ElasticBeanstalk.Model.EnvironmentTier)"> <summary> Sets the Tier property </summary> <param name="tier">The value to set for the Tier property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.WithVersionLabel(System.String)"> <summary> Sets the VersionLabel property </summary> <param name="versionLabel">The value to set for the VersionLabel property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application associated with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.CNAME"> <summary> Gets and sets the property CNAME. <para> The URL to the CNAME for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.DateCreated"> <summary> Gets and sets the property DateCreated. <para> The creation date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.DateUpdated"> <summary> Gets and sets the property DateUpdated. <para> The last modified date for this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.Description"> <summary> Gets and sets the property Description. <para> Describes this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.EndpointURL"> <summary> Gets and sets the property EndpointURL. <para> For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.EnvironmentId"> <summary> Gets and sets the property EnvironmentId. <para> The ID of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.Health"> <summary> Gets and sets the property Health. <para> Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: </para> <enumValues> <value name="Red"> <para> <code>Red</code> : Indicates the environment is not working. </para> </value> <value name="Yellow"> <para> <code>Yellow</code>: Indicates that something is wrong, the application might not be available, but the instances appear running. </para> </value> <value name="Green"> <para> <code>Green</code>: Indicates the environment is healthy and fully functional. </para> </value> </enumValues> <ul> <li> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. </li> <li> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. </li> <li> <code>Green</code>: Indicates the environment is healthy and fully functional. </li> <li> <code>Grey</code>: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an <code>UpdateEnvironment</code> or <code>RestartEnvironement</code> request. </li> </ul> <para> Default: <code>Grey</code> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.Resources"> <summary> Gets and sets the property Resources. <para> The description of the AWS resources used by this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.SolutionStackName"> <summary> Gets and sets the property SolutionStackName. <para> The name of the <code>SolutionStack</code> deployed with this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.Status"> <summary> Gets and sets the property Status. <para> The current operational status of the environment: </para> <ul> <li> <code>Launching</code>: Environment is in the process of initial deployment. </li> <li> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version. </li> <li> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate. </li> <li> <code>Terminating</code>: Environment is in the shut-down process. </li> <li> <code>Terminated</code>: Environment is not running. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template used to originally launch this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.Tier"> <summary> Gets and sets the property Tier. <para> Describes the current tier of this environment. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.UpdateEnvironmentResult.VersionLabel"> <summary> Gets and sets the property VersionLabel. <para> The application version deployed in this environment. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest"> <summary> Container for the parameters to the ValidateConfigurationSettings operation. 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> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.WithApplicationName(System.String)"> <summary> Sets the ApplicationName property </summary> <param name="applicationName">The value to set for the ApplicationName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.WithEnvironmentName(System.String)"> <summary> Sets the EnvironmentName property </summary> <param name="environmentName">The value to set for the EnvironmentName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.WithOptionSettings(Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting[])"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.WithOptionSettings(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ConfigurationOptionSetting})"> <summary> Sets the OptionSettings property </summary> <param name="optionSettings">The values to add to the OptionSettings collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.WithTemplateName(System.String)"> <summary> Sets the TemplateName property </summary> <param name="templateName">The value to set for the TemplateName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application that the configuration template or environment belongs to. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.EnvironmentName"> <summary> Gets and sets the property EnvironmentName. <para> The name of the environment to validate the settings against. </para> <para> Condition: You cannot specify both this and a configuration template name. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.OptionSettings"> <summary> Gets and sets the property OptionSettings. <para> A list of the options and desired values to evaluate. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsRequest.TemplateName"> <summary> Gets and sets the property TemplateName. <para> The name of the configuration template to validate the settings against. </para> <para> Condition: You cannot specify both this and an environment name. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsResponse"> <summary> Returns information about the ValidateConfigurationSettingsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsResponse.ValidateConfigurationSettingsResult"> <summary> Gets and sets the ValidateConfigurationSettingsResult property. Represents the output of a ValidateConfigurationSettings operation. </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsResult"> <summary> Provides a list of validation messages. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsResult.WithMessages(Amazon.ElasticBeanstalk.Model.ValidationMessage[])"> <summary> Sets the Messages property </summary> <param name="messages">The values to add to the Messages collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsResult.WithMessages(System.Collections.Generic.IEnumerable{Amazon.ElasticBeanstalk.Model.ValidationMessage})"> <summary> Sets the Messages property </summary> <param name="messages">The values to add to the Messages collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidateConfigurationSettingsResult.Messages"> <summary> Gets and sets the property Messages. <para> A list of <a>ValidationMessage</a>. </para> </summary> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ValidationErrorException"> <summary> AmazonElasticBeanstalk exception </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidationErrorException.#ctor(System.String)"> <summary> Constructs a new ValidationErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticBeanstalk.Model.ValidationMessage"> <summary> An error or warning for a desired configuration option value. </summary> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidationMessage.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidationMessage.WithNamespace(System.String)"> <summary> Sets the Namespace property </summary> <param name="ns">The value to set for the Namespace property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidationMessage.WithOptionName(System.String)"> <summary> Sets the OptionName property </summary> <param name="optionName">The value to set for the OptionName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticBeanstalk.Model.ValidationMessage.WithSeverity(System.String)"> <summary> Sets the Severity property </summary> <param name="severity">The value to set for the Severity property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidationMessage.Message"> <summary> Gets and sets the property Message. <para> A message describing the error or warning. </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidationMessage.Namespace"> <summary> Gets and sets the property Namespace. <para> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidationMessage.OptionName"> <summary> Gets and sets the property OptionName. <para> </para> </summary> </member> <member name="P:Amazon.ElasticBeanstalk.Model.ValidationMessage.Severity"> <summary> Gets and sets the property Severity. <para> An indication of the severity of this message: </para> <enumValues> <value name="error"> <para> error: This message indicates that this is not a valid setting for an option. </para> </value> <value name="warning"> <para> warning: This message is providing information you should take into account. </para> </value> </enumValues> <ul> <li> error: This message indicates that this is not a valid setting for an option. </li> <li> warning: This message is providing information you should take into account. </li> </ul> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing"> <summary> Interface for accessing AmazonElasticLoadBalancing. Elastic Load Balancing <para> Elastic Load Balancing is a cost-effective and easy to use web service to help you improve the availability and scalability of your application running on Amazon Elastic Cloud Compute (Amazon EC2). It makes it easy for you to distribute application loads between two or more EC2 instances. Elastic Load Balancing supports the growth in traffic of your application by enabling availability through redundancy. </para> <para>This guide provides detailed information about Elastic Load Balancing actions, data types, and parameters that can be used for sending a query request. Query requests are HTTP or HTTPS requests that use the HTTP verb GET or POST and a query parameter named Action or Operation. Action is used throughout this documentation, although Operation is supported for backward compatibility with other AWS Query APIs.</para> <para>For detailed information on constructing a query request using the actions, data types, and parameters mentioned in this guide, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-query-api.html" >Using the Query API</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para>For detailed information about Elastic Load Balancing features and their associated actions, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenarios.html" >Using Elastic Load Balancing</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para>This reference guide is based on the current WSDL, which is available at: <a href="http://ec2-downloads.s3.amazonaws.com/ElasticLoadBalancing.wsdl" >http://ec2-downloads.s3.amazonaws.com/ElasticLoadBalancing.wsdl</a> </para> <para> <b>Endpoints</b> </para> <para>The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.</para> <para>You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see <a href="http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html" >Regions and Endpoints</a> in the Amazon Web Services General Reference. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"> <summary> <para> Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer. </para> </summary> <param name="describeLoadBalancerPolicyTypesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"/> </summary> <param name="describeLoadBalancerPolicyTypesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancerPolicyTypes operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDescribeLoadBalancerPolicyTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancerPolicyTypes.</param> <returns>Returns a DescribeLoadBalancerPolicyTypesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes"> <summary> <para> Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"> <summary> <para> Specifies the health check settings to use for evaluating the health state of your back-end instances. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#healthcheck">Health Check</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="configureHealthCheckRequest">Container for the necessary parameters to execute the ConfigureHealthCheck service method on AmazonElasticLoadBalancing.</param> <returns>The response from the ConfigureHealthCheck service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfigureHealthCheck operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"/> </summary> <param name="configureHealthCheckRequest">Container for the necessary parameters to execute the ConfigureHealthCheck operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfigureHealthCheck operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndConfigureHealthCheck(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfigureHealthCheck operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfigureHealthCheck.</param> <returns>Returns a ConfigureHealthCheckResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"> <summary> <para> Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. </para> <para> After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the <i>OutOfService</i> state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer. </para> </summary> <param name="detachLoadBalancerFromSubnetsRequest">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DetachLoadBalancerFromSubnets service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancerFromSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"/> </summary> <param name="detachLoadBalancerFromSubnetsRequest">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachLoadBalancerFromSubnets operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDetachLoadBalancerFromSubnets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachLoadBalancerFromSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachLoadBalancerFromSubnets.</param> <returns>Returns a DetachLoadBalancerFromSubnetsResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"> <summary> <para>Modifies the attributes of a specified load balancer.</para> <para>You can modify the load balancer attributes, such as <c>AccessLogs</c> , <c>ConnectionDraining</c> , and <c>CrossZoneLoadBalancing</c> by either enabling or disabling them.</para> <para>For information on cross-zone load balancing, see <b>Request Routing</b> and for information on connection draining, see <b>Connection Draining</b> in the <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html">Concepts</a> section of the <i>Elastic Load Balancer Developer Guide</i> . For information on access logs, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/access-log-collection.html">Access Logs</a> .</para> </summary> <param name="modifyLoadBalancerAttributesRequest">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes service method on AmazonElasticLoadBalancing.</param> <returns>The response from the ModifyLoadBalancerAttributes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"/> </summary> <param name="modifyLoadBalancerAttributesRequest">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyLoadBalancerAttributes operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndModifyLoadBalancerAttributes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyLoadBalancerAttributes.</param> <returns>Returns a ModifyLoadBalancerAttributesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"> <summary> <para> Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener. </para> <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="createLoadBalancerListenersRequest">Container for the necessary parameters to execute the CreateLoadBalancerListeners service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateListenerException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginCreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"/> </summary> <param name="createLoadBalancerListenersRequest">Container for the necessary parameters to execute the CreateLoadBalancerListeners operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoadBalancerListeners operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndCreateLoadBalancerListeners(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoadBalancerListeners.</param> <returns>Returns a CreateLoadBalancerListenersResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"> <summary> <para> Deletes listeners from the load balancer for the specified port. </para> </summary> <param name="deleteLoadBalancerListenersRequest">Container for the necessary parameters to execute the DeleteLoadBalancerListeners service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeleteLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"/> </summary> <param name="deleteLoadBalancerListenersRequest">Container for the necessary parameters to execute the DeleteLoadBalancerListeners operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoadBalancerListeners operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDeleteLoadBalancerListeners(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoadBalancerListeners.</param> <returns>Returns a DeleteLoadBalancerListenersResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"> <summary> <para> 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> <para> This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie 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><b>NOTE:</b> An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsAppCookies">Enabling Application-Controlled Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="createAppCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateAppCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginCreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAppCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"/> </summary> <param name="createAppCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAppCookieStickinessPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndCreateAppCookieStickinessPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAppCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAppCookieStickinessPolicy.</param> <returns>Returns a CreateAppCookieStickinessPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"> <summary> <para> Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/USVPC_ApplySG.html">Manage Security Groups in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="applySecurityGroupsToLoadBalancerRequest">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the ApplySecurityGroupsToLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"/> </summary> <param name="applySecurityGroupsToLoadBalancerRequest">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndApplySecurityGroupsToLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndApplySecurityGroupsToLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginApplySecurityGroupsToLoadBalancer.</param> <returns>Returns a ApplySecurityGroupsToLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"> <summary> <para>Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the 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 the sample policies. The names of the sample policies have the <c>ELBSample-</c> prefix. </para> </summary> <param name="describeLoadBalancerPoliciesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicies operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"/> </summary> <param name="describeLoadBalancerPoliciesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancerPolicies operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDescribeLoadBalancerPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancerPolicies operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancerPolicies.</param> <returns>Returns a DescribeLoadBalancerPoliciesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies"> <summary> <para>Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the 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 the sample policies. The names of the sample policies have the <c>ELBSample-</c> prefix. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"> <summary> <para> Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener. </para> </summary> <param name="setLoadBalancerPoliciesOfListenerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener service method on AmazonElasticLoadBalancing.</param> <returns>The response from the SetLoadBalancerPoliciesOfListener service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginSetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"/> </summary> <param name="setLoadBalancerPoliciesOfListenerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetLoadBalancerPoliciesOfListener operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndSetLoadBalancerPoliciesOfListener(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetLoadBalancerPoliciesOfListener.</param> <returns>Returns a SetLoadBalancerPoliciesOfListenerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"> <summary> <para> Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer. </para> <para> There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the <i>OutOfService</i> state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing. </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="disableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DisableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="disableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableAvailabilityZonesForLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDisableAvailabilityZonesForLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableAvailabilityZonesForLoadBalancer.</param> <returns>Returns a DisableAvailabilityZonesForLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"> <summary> <para> Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned. </para> <para><b>NOTE:</b> You must provide the same account credentials as those that were used to create the load balancer. </para> </summary> <param name="describeInstanceHealthRequest">Container for the necessary parameters to execute the DescribeInstanceHealth service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeInstanceHealth service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstanceHealth operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"/> </summary> <param name="describeInstanceHealthRequest">Container for the necessary parameters to execute the DescribeInstanceHealth operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstanceHealth operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDescribeInstanceHealth(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstanceHealth operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstanceHealth.</param> <returns>Returns a DescribeInstanceHealthResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"> <summary> <para> Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners. </para> </summary> <param name="deleteLoadBalancerPolicyRequest">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeleteLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"/> </summary> <param name="deleteLoadBalancerPolicyRequest">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoadBalancerPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDeleteLoadBalancerPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoadBalancerPolicy.</param> <returns>Returns a DeleteLoadBalancerPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"> <summary> <para> Creates a new policy that contains the necessary attributes depending on the policy type. 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 your policy type. </para> </summary> <param name="createLoadBalancerPolicyRequest">Container for the necessary parameters to execute the CreateLoadBalancerPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginCreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"/> </summary> <param name="createLoadBalancerPolicyRequest">Container for the necessary parameters to execute the CreateLoadBalancerPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoadBalancerPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndCreateLoadBalancerPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoadBalancerPolicy.</param> <returns>Returns a CreateLoadBalancerPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"> <summary> <para> Adds one or more EC2 Availability Zones to the load balancer. </para> <para> The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. </para> <para><b>NOTE:</b> The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_AddLBAvailabilityZone.html">Expand a Load Balanced Application to an Additional Availability Zone</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="enableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the EnableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginEnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="enableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableAvailabilityZonesForLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndEnableAvailabilityZonesForLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableAvailabilityZonesForLoadBalancer.</param> <returns>Returns a EnableAvailabilityZonesForLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"> <summary> <para> Deletes the specified load balancer. </para> <para> If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances. </para> <para> To successfully call this API, you must provide the same account credentials as were used to create the load balancer. </para> <para><b>NOTE:</b> By design, if the load balancer does not exist or has already been deleted, a call to DeleteLoadBalancer action still succeeds. </para> </summary> <param name="deleteLoadBalancerRequest">Container for the necessary parameters to execute the DeleteLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeleteLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"/> </summary> <param name="deleteLoadBalancerRequest">Container for the necessary parameters to execute the DeleteLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDeleteLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoadBalancer.</param> <returns>Returns a DeleteLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"> <summary> <para> Creates a new load balancer. </para> <para> After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:</para> <ul> <li> <i>us-east-1.elb.amazonaws.com</i> (for the Northern Virginia Region) </li> <li> <i>us-west-1.elb.amazonaws.com</i> (for the Northern California Region) </li> </ul> <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</a> .</para> <para>You can create up to 20 load balancers per region per account.</para> <para>Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:</para> <ul> <li> <i>EC2-Classic</i> <para>For information on creating and managing your load balancers in EC2-Classic, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForEC2.html">Deploy Elastic Load Balancing in Amazon EC2-Classic</a> .</para> </li> <li> <i>EC2-VPC</i> <para>For information on creating and managing your load balancers in EC2-VPC, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Deploy Elastic Load Balancing in Amazon VPC</a> .</para> </li> </ul> </summary> <param name="createLoadBalancerRequest">Container for the necessary parameters to execute the CreateLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSchemeException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateLoadBalancerNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyLoadBalancersException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginCreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"/> </summary> <param name="createLoadBalancerRequest">Container for the necessary parameters to execute the CreateLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndCreateLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoadBalancer.</param> <returns>Returns a CreateLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"> <summary> <para> Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. 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> <para><b>NOTE:</b> The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable. </para> <para>You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.</para> </summary> <param name="setLoadBalancerPoliciesForBackendServerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the SetLoadBalancerPoliciesForBackendServer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginSetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"/> </summary> <param name="setLoadBalancerPoliciesForBackendServerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetLoadBalancerPoliciesForBackendServer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndSetLoadBalancerPoliciesForBackendServer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetLoadBalancerPoliciesForBackendServer.</param> <returns>Returns a SetLoadBalancerPoliciesForBackendServerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"> <summary> <para> Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer. </para> <para> In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">De-register and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para>You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.</para> </summary> <param name="deregisterInstancesFromLoadBalancerRequest">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeregisterInstancesFromLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"/> </summary> <param name="deregisterInstancesFromLoadBalancerRequest">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterInstancesFromLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDeregisterInstancesFromLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterInstancesFromLoadBalancer.</param> <returns>Returns a DeregisterInstancesFromLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"> <summary> <para> 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> <para>For more information on 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="setLoadBalancerListenerSSLCertificateRequest">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate service method on AmazonElasticLoadBalancing.</param> <returns>The response from the SetLoadBalancerListenerSSLCertificate service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginSetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"/> </summary> <param name="setLoadBalancerListenerSSLCertificateRequest">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetLoadBalancerListenerSSLCertificate operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndSetLoadBalancerListenerSSLCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetLoadBalancerListenerSSLCertificate.</param> <returns>Returns a SetLoadBalancerListenerSSLCertificateResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"> <summary> <para>Returns detailed information about all of the attributes associated with the specified load balancer.</para> </summary> <param name="describeLoadBalancerAttributesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancerAttributes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"/> </summary> <param name="describeLoadBalancerAttributesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancerAttributes operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDescribeLoadBalancerAttributes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancerAttributes.</param> <returns>Returns a DescribeLoadBalancerAttributesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"> <summary> <para> 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> <para> When a load balancer implements this policy, the load balancer uses a special cookie to track the backend 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/US_StickySessions.html#US_EnableStickySessionsLBCookies">Enabling Duration-Based Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="createLBCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLBCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginCreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLBCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"/> </summary> <param name="createLBCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLBCookieStickinessPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndCreateLBCookieStickinessPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLBCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLBCookieStickinessPolicy.</param> <returns>Returns a CreateLBCookieStickinessPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"> <summary> <para> Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. </para> <para> The load balancers evenly distribute requests across all of the registered subnets. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Deploy Elastic Load Balancing in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i> . </para> </summary> <param name="attachLoadBalancerToSubnetsRequest">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets service method on AmazonElasticLoadBalancing.</param> <returns>The response from the AttachLoadBalancerToSubnets service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginAttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancerToSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"/> </summary> <param name="attachLoadBalancerToSubnetsRequest">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachLoadBalancerToSubnets operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndAttachLoadBalancerToSubnets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachLoadBalancerToSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachLoadBalancerToSubnets.</param> <returns>Returns a AttachLoadBalancerToSubnetsResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"> <summary> <para> Adds new instances to the load balancer. </para> <para> Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the <i>OutOfService</i> state. It will move to the <i>InService</i> state when the Availability Zone is added to the load balancer. </para> <para>When an instance registered with a load balancer is stopped and then restarted, 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 de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.</para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">De-register and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para><b>NOTE:</b> In order for this call to be successful, you must provide the same account credentials as those that were used to create the load balancer. </para> <para><b>NOTE:</b> Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly. </para> <para>You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.</para> </summary> <param name="registerInstancesWithLoadBalancerRequest">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the RegisterInstancesWithLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginRegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterInstancesWithLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"/> </summary> <param name="registerInstancesWithLoadBalancerRequest">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterInstancesWithLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndRegisterInstancesWithLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterInstancesWithLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterInstancesWithLoadBalancer.</param> <returns>Returns a RegisterInstancesWithLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"> <summary> <para> Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers. </para> <para><b>NOTE:</b> In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.</para> </summary> <param name="describeLoadBalancersRequest">Container for the necessary parameters to execute the DescribeLoadBalancers service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.BeginDescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"/> </summary> <param name="describeLoadBalancersRequest">Container for the necessary parameters to execute the DescribeLoadBalancers operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancers operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EndDescribeLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancers operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancers.</param> <returns>Returns a DescribeLoadBalancersResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancers"> <summary> <para> Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers. </para> <para><b>NOTE:</b> In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.</para> </summary> <returns>The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="T:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient"> <summary> Implementation for accessing AmazonElasticLoadBalancing. Elastic Load Balancing <para> Elastic Load Balancing is a cost-effective and easy to use web service to help you improve the availability and scalability of your application running on Amazon Elastic Cloud Compute (Amazon EC2). It makes it easy for you to distribute application loads between two or more EC2 instances. Elastic Load Balancing supports the growth in traffic of your application by enabling availability through redundancy. </para> <para>This guide provides detailed information about Elastic Load Balancing actions, data types, and parameters that can be used for sending a query request. Query requests are HTTP or HTTPS requests that use the HTTP verb GET or POST and a query parameter named Action or Operation. Action is used throughout this documentation, although Operation is supported for backward compatibility with other AWS Query APIs.</para> <para>For detailed information on constructing a query request using the actions, data types, and parameters mentioned in this guide, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-query-api.html" >Using the Query API</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para>For detailed information about Elastic Load Balancing features and their associated actions, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenarios.html" >Using Elastic Load Balancing</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para>This reference guide is based on the current WSDL, which is available at: <a href="http://ec2-downloads.s3.amazonaws.com/ElasticLoadBalancing.wsdl" >http://ec2-downloads.s3.amazonaws.com/ElasticLoadBalancing.wsdl</a> </para> <para> <b>Endpoints</b> </para> <para>The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.</para> <para>You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see <a href="http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html" >Regions and Endpoints</a> in the Amazon Web Services General Reference. </para> </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonElasticLoadBalancing 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"> <summary> <para> Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer. </para> </summary> <param name="describeLoadBalancerPolicyTypesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"/> </summary> <param name="describeLoadBalancerPolicyTypesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicyTypes operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancerPolicyTypes operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDescribeLoadBalancerPolicyTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancerPolicyTypes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancerPolicyTypes.</param> <returns>Returns a DescribeLoadBalancerPolicyTypesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicyTypes"> <summary> <para> Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicyTypes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"> <summary> <para> Specifies the health check settings to use for evaluating the health state of your back-end instances. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#healthcheck">Health Check</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="configureHealthCheckRequest">Container for the necessary parameters to execute the ConfigureHealthCheck service method on AmazonElasticLoadBalancing.</param> <returns>The response from the ConfigureHealthCheck service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfigureHealthCheck operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"/> </summary> <param name="configureHealthCheckRequest">Container for the necessary parameters to execute the ConfigureHealthCheck operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfigureHealthCheck operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndConfigureHealthCheck(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfigureHealthCheck operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfigureHealthCheck.</param> <returns>Returns a ConfigureHealthCheckResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"> <summary> <para> Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. </para> <para> After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the <i>OutOfService</i> state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer. </para> </summary> <param name="detachLoadBalancerFromSubnetsRequest">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DetachLoadBalancerFromSubnets service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancerFromSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"/> </summary> <param name="detachLoadBalancerFromSubnetsRequest">Container for the necessary parameters to execute the DetachLoadBalancerFromSubnets operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachLoadBalancerFromSubnets operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDetachLoadBalancerFromSubnets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachLoadBalancerFromSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachLoadBalancerFromSubnets.</param> <returns>Returns a DetachLoadBalancerFromSubnetsResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"> <summary> <para>Modifies the attributes of a specified load balancer.</para> <para>You can modify the load balancer attributes, such as <c>AccessLogs</c> , <c>ConnectionDraining</c> , and <c>CrossZoneLoadBalancing</c> by either enabling or disabling them.</para> <para>For information on cross-zone load balancing, see <b>Request Routing</b> and for information on connection draining, see <b>Connection Draining</b> in the <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html">Concepts</a> section of the <i>Elastic Load Balancer Developer Guide</i> . For information on access logs, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/access-log-collection.html">Access Logs</a> .</para> </summary> <param name="modifyLoadBalancerAttributesRequest">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes service method on AmazonElasticLoadBalancing.</param> <returns>The response from the ModifyLoadBalancerAttributes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"/> </summary> <param name="modifyLoadBalancerAttributesRequest">Container for the necessary parameters to execute the ModifyLoadBalancerAttributes operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyLoadBalancerAttributes operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndModifyLoadBalancerAttributes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyLoadBalancerAttributes.</param> <returns>Returns a ModifyLoadBalancerAttributesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"> <summary> <para> Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener. </para> <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="createLoadBalancerListenersRequest">Container for the necessary parameters to execute the CreateLoadBalancerListeners service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateListenerException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginCreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"/> </summary> <param name="createLoadBalancerListenersRequest">Container for the necessary parameters to execute the CreateLoadBalancerListeners operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoadBalancerListeners operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndCreateLoadBalancerListeners(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoadBalancerListeners.</param> <returns>Returns a CreateLoadBalancerListenersResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"> <summary> <para> Deletes listeners from the load balancer for the specified port. </para> </summary> <param name="deleteLoadBalancerListenersRequest">Container for the necessary parameters to execute the DeleteLoadBalancerListeners service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeleteLoadBalancerListeners service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"/> </summary> <param name="deleteLoadBalancerListenersRequest">Container for the necessary parameters to execute the DeleteLoadBalancerListeners operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoadBalancerListeners operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDeleteLoadBalancerListeners(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoadBalancerListeners operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoadBalancerListeners.</param> <returns>Returns a DeleteLoadBalancerListenersResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"> <summary> <para> 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> <para> This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie 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><b>NOTE:</b> An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsAppCookies">Enabling Application-Controlled Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="createAppCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateAppCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginCreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAppCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"/> </summary> <param name="createAppCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateAppCookieStickinessPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAppCookieStickinessPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndCreateAppCookieStickinessPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAppCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAppCookieStickinessPolicy.</param> <returns>Returns a CreateAppCookieStickinessPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"> <summary> <para> Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/USVPC_ApplySG.html">Manage Security Groups in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="applySecurityGroupsToLoadBalancerRequest">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the ApplySecurityGroupsToLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"/> </summary> <param name="applySecurityGroupsToLoadBalancerRequest">Container for the necessary parameters to execute the ApplySecurityGroupsToLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndApplySecurityGroupsToLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndApplySecurityGroupsToLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ApplySecurityGroupsToLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginApplySecurityGroupsToLoadBalancer.</param> <returns>Returns a ApplySecurityGroupsToLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"> <summary> <para>Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the 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 the sample policies. The names of the sample policies have the <c>ELBSample-</c> prefix. </para> </summary> <param name="describeLoadBalancerPoliciesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerPolicies operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"/> </summary> <param name="describeLoadBalancerPoliciesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerPolicies operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancerPolicies operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDescribeLoadBalancerPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancerPolicies operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancerPolicies.</param> <returns>Returns a DescribeLoadBalancerPoliciesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerPolicies"> <summary> <para>Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the 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 the sample policies. The names of the sample policies have the <c>ELBSample-</c> prefix. </para> </summary> <returns>The response from the DescribeLoadBalancerPolicies service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"> <summary> <para> Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener. </para> </summary> <param name="setLoadBalancerPoliciesOfListenerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener service method on AmazonElasticLoadBalancing.</param> <returns>The response from the SetLoadBalancerPoliciesOfListener service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginSetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"/> </summary> <param name="setLoadBalancerPoliciesOfListenerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesOfListener operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetLoadBalancerPoliciesOfListener operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndSetLoadBalancerPoliciesOfListener(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetLoadBalancerPoliciesOfListener operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetLoadBalancerPoliciesOfListener.</param> <returns>Returns a SetLoadBalancerPoliciesOfListenerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"> <summary> <para> Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer. </para> <para> There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the <i>OutOfService</i> state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing. </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="disableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DisableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="disableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the DisableAvailabilityZonesForLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableAvailabilityZonesForLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDisableAvailabilityZonesForLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableAvailabilityZonesForLoadBalancer.</param> <returns>Returns a DisableAvailabilityZonesForLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"> <summary> <para> Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned. </para> <para><b>NOTE:</b> You must provide the same account credentials as those that were used to create the load balancer. </para> </summary> <param name="describeInstanceHealthRequest">Container for the necessary parameters to execute the DescribeInstanceHealth service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeInstanceHealth service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstanceHealth operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"/> </summary> <param name="describeInstanceHealthRequest">Container for the necessary parameters to execute the DescribeInstanceHealth operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstanceHealth operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDescribeInstanceHealth(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstanceHealth operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstanceHealth.</param> <returns>Returns a DescribeInstanceHealthResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"> <summary> <para> Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners. </para> </summary> <param name="deleteLoadBalancerPolicyRequest">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeleteLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"/> </summary> <param name="deleteLoadBalancerPolicyRequest">Container for the necessary parameters to execute the DeleteLoadBalancerPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoadBalancerPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDeleteLoadBalancerPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoadBalancerPolicy.</param> <returns>Returns a DeleteLoadBalancerPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"> <summary> <para> Creates a new policy that contains the necessary attributes depending on the policy type. 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 your policy type. </para> </summary> <param name="createLoadBalancerPolicyRequest">Container for the necessary parameters to execute the CreateLoadBalancerPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLoadBalancerPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginCreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"/> </summary> <param name="createLoadBalancerPolicyRequest">Container for the necessary parameters to execute the CreateLoadBalancerPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoadBalancerPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndCreateLoadBalancerPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoadBalancerPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoadBalancerPolicy.</param> <returns>Returns a CreateLoadBalancerPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"> <summary> <para> Adds one or more EC2 Availability Zones to the load balancer. </para> <para> The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. </para> <para><b>NOTE:</b> The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_AddLBAvailabilityZone.html">Expand a Load Balanced Application to an Additional Availability Zone</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="enableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the EnableAvailabilityZonesForLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginEnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="enableAvailabilityZonesForLoadBalancerRequest">Container for the necessary parameters to execute the EnableAvailabilityZonesForLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableAvailabilityZonesForLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndEnableAvailabilityZonesForLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableAvailabilityZonesForLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableAvailabilityZonesForLoadBalancer.</param> <returns>Returns a EnableAvailabilityZonesForLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"> <summary> <para> Deletes the specified load balancer. </para> <para> If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances. </para> <para> To successfully call this API, you must provide the same account credentials as were used to create the load balancer. </para> <para><b>NOTE:</b> By design, if the load balancer does not exist or has already been deleted, a call to DeleteLoadBalancer action still succeeds. </para> </summary> <param name="deleteLoadBalancerRequest">Container for the necessary parameters to execute the DeleteLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeleteLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"/> </summary> <param name="deleteLoadBalancerRequest">Container for the necessary parameters to execute the DeleteLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDeleteLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoadBalancer.</param> <returns>Returns a DeleteLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"> <summary> <para> Creates a new load balancer. </para> <para> After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:</para> <ul> <li> <i>us-east-1.elb.amazonaws.com</i> (for the Northern Virginia Region) </li> <li> <i>us-west-1.elb.amazonaws.com</i> (for the Northern California Region) </li> </ul> <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</a> .</para> <para>You can create up to 20 load balancers per region per account.</para> <para>Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:</para> <ul> <li> <i>EC2-Classic</i> <para>For information on creating and managing your load balancers in EC2-Classic, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForEC2.html">Deploy Elastic Load Balancing in Amazon EC2-Classic</a> .</para> </li> <li> <i>EC2-VPC</i> <para>For information on creating and managing your load balancers in EC2-VPC, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Deploy Elastic Load Balancing in Amazon VPC</a> .</para> </li> </ul> </summary> <param name="createLoadBalancerRequest">Container for the necessary parameters to execute the CreateLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSchemeException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicateLoadBalancerNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyLoadBalancersException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginCreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"/> </summary> <param name="createLoadBalancerRequest">Container for the necessary parameters to execute the CreateLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndCreateLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoadBalancer.</param> <returns>Returns a CreateLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"> <summary> <para> Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. 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> <para><b>NOTE:</b> The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable. </para> <para>You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.</para> </summary> <param name="setLoadBalancerPoliciesForBackendServerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the SetLoadBalancerPoliciesForBackendServer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginSetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"/> </summary> <param name="setLoadBalancerPoliciesForBackendServerRequest">Container for the necessary parameters to execute the SetLoadBalancerPoliciesForBackendServer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetLoadBalancerPoliciesForBackendServer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndSetLoadBalancerPoliciesForBackendServer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetLoadBalancerPoliciesForBackendServer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetLoadBalancerPoliciesForBackendServer.</param> <returns>Returns a SetLoadBalancerPoliciesForBackendServerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"> <summary> <para> Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer. </para> <para> In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">De-register and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para>You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.</para> </summary> <param name="deregisterInstancesFromLoadBalancerRequest">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DeregisterInstancesFromLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"/> </summary> <param name="deregisterInstancesFromLoadBalancerRequest">Container for the necessary parameters to execute the DeregisterInstancesFromLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterInstancesFromLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDeregisterInstancesFromLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterInstancesFromLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterInstancesFromLoadBalancer.</param> <returns>Returns a DeregisterInstancesFromLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"> <summary> <para> 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> <para>For more information on 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="setLoadBalancerListenerSSLCertificateRequest">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate service method on AmazonElasticLoadBalancing.</param> <returns>The response from the SetLoadBalancerListenerSSLCertificate service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginSetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"/> </summary> <param name="setLoadBalancerListenerSSLCertificateRequest">Container for the necessary parameters to execute the SetLoadBalancerListenerSSLCertificate operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetLoadBalancerListenerSSLCertificate operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndSetLoadBalancerListenerSSLCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetLoadBalancerListenerSSLCertificate operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetLoadBalancerListenerSSLCertificate.</param> <returns>Returns a SetLoadBalancerListenerSSLCertificateResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"> <summary> <para>Returns detailed information about all of the attributes associated with the specified load balancer.</para> </summary> <param name="describeLoadBalancerAttributesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancerAttributes service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"/> </summary> <param name="describeLoadBalancerAttributesRequest">Container for the necessary parameters to execute the DescribeLoadBalancerAttributes operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancerAttributes operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDescribeLoadBalancerAttributes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancerAttributes operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancerAttributes.</param> <returns>Returns a DescribeLoadBalancerAttributesResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"> <summary> <para> 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> <para> When a load balancer implements this policy, the load balancer uses a special cookie to track the backend 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/US_StickySessions.html#US_EnableStickySessionsLBCookies">Enabling Duration-Based Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <param name="createLBCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy service method on AmazonElasticLoadBalancing.</param> <returns>The response from the CreateLBCookieStickinessPolicy service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginCreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLBCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"/> </summary> <param name="createLBCookieStickinessPolicyRequest">Container for the necessary parameters to execute the CreateLBCookieStickinessPolicy operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLBCookieStickinessPolicy operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndCreateLBCookieStickinessPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLBCookieStickinessPolicy operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLBCookieStickinessPolicy.</param> <returns>Returns a CreateLBCookieStickinessPolicyResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"> <summary> <para> Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. </para> <para> The load balancers evenly distribute requests across all of the registered subnets. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Deploy Elastic Load Balancing in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i> . </para> </summary> <param name="attachLoadBalancerToSubnetsRequest">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets service method on AmazonElasticLoadBalancing.</param> <returns>The response from the AttachLoadBalancerToSubnets service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginAttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancerToSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"/> </summary> <param name="attachLoadBalancerToSubnetsRequest">Container for the necessary parameters to execute the AttachLoadBalancerToSubnets operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachLoadBalancerToSubnets operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndAttachLoadBalancerToSubnets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachLoadBalancerToSubnets operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachLoadBalancerToSubnets.</param> <returns>Returns a AttachLoadBalancerToSubnetsResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"> <summary> <para> Adds new instances to the load balancer. </para> <para> Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the <i>OutOfService</i> state. It will move to the <i>InService</i> state when the Availability Zone is added to the load balancer. </para> <para>When an instance registered with a load balancer is stopped and then restarted, 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 de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.</para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">De-register and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para><b>NOTE:</b> In order for this call to be successful, you must provide the same account credentials as those that were used to create the load balancer. </para> <para><b>NOTE:</b> Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly. </para> <para>You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.</para> </summary> <param name="registerInstancesWithLoadBalancerRequest">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer service method on AmazonElasticLoadBalancing.</param> <returns>The response from the RegisterInstancesWithLoadBalancer service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> <exception cref="T:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginRegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterInstancesWithLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"/> </summary> <param name="registerInstancesWithLoadBalancerRequest">Container for the necessary parameters to execute the RegisterInstancesWithLoadBalancer operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterInstancesWithLoadBalancer operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndRegisterInstancesWithLoadBalancer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterInstancesWithLoadBalancer operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterInstancesWithLoadBalancer.</param> <returns>Returns a RegisterInstancesWithLoadBalancerResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"> <summary> <para> Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers. </para> <para><b>NOTE:</b> In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.</para> </summary> <param name="describeLoadBalancersRequest">Container for the necessary parameters to execute the DescribeLoadBalancers service method on AmazonElasticLoadBalancing.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.BeginDescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"/> </summary> <param name="describeLoadBalancersRequest">Container for the necessary parameters to execute the DescribeLoadBalancers operation on AmazonElasticLoadBalancing.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLoadBalancers operation.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.EndDescribeLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancers operation. <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancers.</param> <returns>Returns a DescribeLoadBalancersResult from AmazonElasticLoadBalancing.</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingClient.DescribeLoadBalancers"> <summary> <para> Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers. </para> <para><b>NOTE:</b> In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.</para> </summary> <returns>The response from the DescribeLoadBalancers service method, as returned by AmazonElasticLoadBalancing.</returns> <exception cref="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"/> </member> <member name="T:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig"> <summary> Configuration for accessing Elastic Load Balancing service </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancingConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.AccessLog"> <summary> <para>The <c>AccessLog</c> data type.</para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AccessLog.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AccessLog.WithS3BucketName(System.String)"> <summary> Sets the S3BucketName property </summary> <param name="s3BucketName">The value to set for the S3BucketName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AccessLog.WithEmitInterval(System.Int32)"> <summary> Sets the EmitInterval property </summary> <param name="emitInterval">The value to set for the EmitInterval property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AccessLog.WithS3BucketPrefix(System.String)"> <summary> Sets the S3BucketPrefix property </summary> <param name="s3BucketPrefix">The value to set for the S3BucketPrefix property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AccessLog.Enabled"> <summary> Specifies whether access log is enabled for the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AccessLog.S3BucketName"> <summary> The name of the Amazon S3 bucket where the access logs are stored. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AccessLog.EmitInterval"> <summary> The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes. Default: 60 minutes </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AccessLog.S3BucketPrefix"> <summary> The logical hierarchy you created for your Amazon S3 bucket, for example <c>my-bucket-prefix/prod</c>. If the prefix is not provided, the log is placed at the root level of the bucket. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy"> <summary> <para>The AppCookieStickinessPolicy data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy.#ctor"> <summary> Default constructor for a new AppCookieStickinessPolicy object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy.#ctor(System.String,System.String)"> <summary> Constructs a new AppCookieStickinessPolicy object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="policyName"> The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer. </param> <param name="cookieName"> The name of the application cookie used for stickiness. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy.WithCookieName(System.String)"> <summary> Sets the CookieName property </summary> <param name="cookieName">The value to set for the CookieName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy.PolicyName"> <summary> The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy.CookieName"> <summary> The name of the application cookie used for stickiness. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest"> <summary> Container for the parameters to the ApplySecurityGroupsToLoadBalancer operation. <para> Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/USVPC_ApplySG.html">Manage Security Groups in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ApplySecurityGroupsToLoadBalancer(Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest.WithSecurityGroups(System.String[])"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest.WithSecurityGroups(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest.LoadBalancerName"> <summary> The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerRequest.SecurityGroups"> <summary> A list of security group IDs to associate with your load balancer in VPC. The security group IDs must be provided as the ID and not the security group name (For example, sg-1234). </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerResponse"> <summary> Returns information about the ApplySecurityGroupsToLoadBalancerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerResponse.ApplySecurityGroupsToLoadBalancerResult"> <summary> Gets and sets the ApplySecurityGroupsToLoadBalancerResult property. The out for the ApplySecurityGroupsToLoadBalancer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerResult"> <summary> <para> The out for the ApplySecurityGroupsToLoadBalancer action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerResult.WithSecurityGroups(System.String[])"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerResult.WithSecurityGroups(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ApplySecurityGroupsToLoadBalancerResult.SecurityGroups"> <summary> A list of security group IDs associated with your load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest"> <summary> Container for the parameters to the AttachLoadBalancerToSubnets operation. <para> Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. </para> <para> The load balancers evenly distribute requests across all of the registered subnets. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Deploy Elastic Load Balancing in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i> . </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.AttachLoadBalancerToSubnets(Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest.WithSubnets(System.String[])"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest.WithSubnets(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest.LoadBalancerName"> <summary> The name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsRequest.Subnets"> <summary> A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsResponse"> <summary> Returns information about the AttachLoadBalancerToSubnetsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsResponse.AttachLoadBalancerToSubnetsResult"> <summary> Gets and sets the AttachLoadBalancerToSubnetsResult property. The output for the AttachLoadBalancerToSubnets action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsResult"> <summary> <para> The output for the AttachLoadBalancerToSubnets action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsResult.WithSubnets(System.String[])"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsResult.WithSubnets(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.AttachLoadBalancerToSubnetsResult.Subnets"> <summary> A list of subnet IDs attached to the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.BackendServerDescription"> <summary> <para> This data type is used as a response element in the DescribeLoadBalancers action to describe the configuration of the back-end server. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.BackendServerDescription.WithInstancePort(System.Int32)"> <summary> Sets the InstancePort property </summary> <param name="instancePort">The value to set for the InstancePort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.BackendServerDescription.WithPolicyNames(System.String[])"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.BackendServerDescription.WithPolicyNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.BackendServerDescription.InstancePort"> <summary> Provides the port on which the back-end server is listening. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 65535</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.BackendServerDescription.PolicyNames"> <summary> Provides a list of policy names enabled for the back-end server. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CertificateNotFoundException.#ctor(System.String)"> <summary> Constructs a new CertificateNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest"> <summary> Container for the parameters to the ConfigureHealthCheck operation. <para> Specifies the health check settings to use for evaluating the health state of your back-end instances. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#healthcheck">Health Check</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ConfigureHealthCheck(Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest.#ctor"> <summary> Default constructor for a new ConfigureHealthCheckRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest.#ctor(System.String,Amazon.ElasticLoadBalancing.Model.HealthCheck)"> <summary> Constructs a new ConfigureHealthCheckRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The mnemonic name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account. </param> <param name="healthCheck"> A structure containing the configuration information for the new healthcheck. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest.WithHealthCheck(Amazon.ElasticLoadBalancing.Model.HealthCheck)"> <summary> Sets the HealthCheck property </summary> <param name="healthCheck">The value to set for the HealthCheck property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest.LoadBalancerName"> <summary> The mnemonic name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckRequest.HealthCheck"> <summary> A structure containing the configuration information for the new healthcheck. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckResponse"> <summary> Returns information about the ConfigureHealthCheckResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckResponse.ConfigureHealthCheckResult"> <summary> Gets and sets the ConfigureHealthCheckResult property. The output for the ConfigureHealthCheck action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckResult"> <summary> <para> The output for the ConfigureHealthCheck action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckResult.WithHealthCheck(Amazon.ElasticLoadBalancing.Model.HealthCheck)"> <summary> Sets the HealthCheck property </summary> <param name="healthCheck">The value to set for the HealthCheck property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ConfigureHealthCheckResult.HealthCheck"> <summary> The updated healthcheck for the instances. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ConnectionDraining"> <summary> <para>The <c>ConnectionDraining</c> data type.</para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ConnectionDraining.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ConnectionDraining.WithTimeout(System.Int32)"> <summary> Sets the Timeout property </summary> <param name="timeout">The value to set for the Timeout property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ConnectionDraining.Enabled"> <summary> Specifies whether connection draining is enabled for the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ConnectionDraining.Timeout"> <summary> Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest"> <summary> Container for the parameters to the CreateAppCookieStickinessPolicy operation. <para> 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> <para> This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie 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><b>NOTE:</b> An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsAppCookies">Enabling Application-Controlled Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateAppCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.#ctor"> <summary> Default constructor for a new CreateAppCookieStickinessPolicyRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.#ctor(System.String,System.String,System.String)"> <summary> Constructs a new CreateAppCookieStickinessPolicyRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name of the load balancer. </param> <param name="policyName"> The name of the policy being created. The name must be unique within the set of policies for this load balancer. </param> <param name="cookieName"> Name of the application cookie used for stickiness. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.WithCookieName(System.String)"> <summary> Sets the CookieName property </summary> <param name="cookieName">The value to set for the CookieName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.PolicyName"> <summary> The name of the policy being created. The name must be unique within the set of policies for this load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyRequest.CookieName"> <summary> Name of the application cookie used for stickiness. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyResponse"> <summary> Returns information about the CreateAppCookieStickinessPolicyResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyResponse.CreateAppCookieStickinessPolicyResult"> <summary> Gets and sets the CreateAppCookieStickinessPolicyResult property. The output for the CreateAppCookieStickinessPolicy action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateAppCookieStickinessPolicyResult"> <summary> <para> The output for the CreateAppCookieStickinessPolicy action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest"> <summary> Container for the parameters to the CreateLBCookieStickinessPolicy operation. <para> 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> <para> When a load balancer implements this policy, the load balancer uses a special cookie to track the backend 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/US_StickySessions.html#US_EnableStickySessionsLBCookies">Enabling Duration-Based Session Stickiness</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLBCookieStickinessPolicy(Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.#ctor"> <summary> Default constructor for a new CreateLBCookieStickinessPolicyRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.#ctor(System.String,System.String)"> <summary> Constructs a new CreateLBCookieStickinessPolicyRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. </param> <param name="policyName"> The name of the policy being created. The name must be unique within the set of policies for this load balancer. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.WithCookieExpirationPeriod(System.Int64)"> <summary> Sets the CookieExpirationPeriod property </summary> <param name="cookieExpirationPeriod">The value to set for the CookieExpirationPeriod property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.LoadBalancerName"> <summary> The name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.PolicyName"> <summary> The name of the policy being created. The name must be unique within the set of policies for this load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyRequest.CookieExpirationPeriod"> <summary> The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyResponse"> <summary> Returns information about the CreateLBCookieStickinessPolicyResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyResponse.CreateLBCookieStickinessPolicyResult"> <summary> Gets and sets the CreateLBCookieStickinessPolicyResult property. The output for the CreateLBCookieStickinessPolicy action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLBCookieStickinessPolicyResult"> <summary> <para> The output for the CreateLBCookieStickinessPolicy action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest"> <summary> Container for the parameters to the CreateLoadBalancerListeners operation. <para> Creates one or more listeners on a load balancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener. </para> <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> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest.#ctor"> <summary> Default constructor for a new CreateLoadBalancerListenersRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.ElasticLoadBalancing.Model.Listener})"> <summary> Constructs a new CreateLoadBalancerListenersRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name of the load balancer. </param> <param name="listeners"> A list of <c>LoadBalancerPort</c>, <c>InstancePort</c>, <c>Protocol</c>, and <c>SSLCertificateId</c> items. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest.WithListeners(Amazon.ElasticLoadBalancing.Model.Listener[])"> <summary> Adds elements to the Listeners collection </summary> <param name="listeners">The values to add to the Listeners collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest.WithListeners(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Listener})"> <summary> Adds elements to the Listeners collection </summary> <param name="listeners">The values to add to the Listeners collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersRequest.Listeners"> <summary> A list of <c>LoadBalancerPort</c>, <c>InstancePort</c>, <c>Protocol</c>, and <c>SSLCertificateId</c> items. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersResponse"> <summary> Returns information about the CreateLoadBalancerListenersResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersResponse.CreateLoadBalancerListenersResult"> <summary> Gets and sets the CreateLoadBalancerListenersResult property. The output for the CreateLoadBalancerListeners action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerListenersResult"> <summary> <para> The output for the CreateLoadBalancerListeners action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest"> <summary> Container for the parameters to the CreateLoadBalancerPolicy operation. <para> Creates a new policy that contains the necessary attributes depending on the policy type. 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 your policy type. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.WithPolicyTypeName(System.String)"> <summary> Sets the PolicyTypeName property </summary> <param name="policyTypeName">The value to set for the PolicyTypeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.WithPolicyAttributes(Amazon.ElasticLoadBalancing.Model.PolicyAttribute[])"> <summary> Adds elements to the PolicyAttributes collection </summary> <param name="policyAttributes">The values to add to the PolicyAttributes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.WithPolicyAttributes(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.PolicyAttribute})"> <summary> Adds elements to the PolicyAttributes collection </summary> <param name="policyAttributes">The values to add to the PolicyAttributes collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.LoadBalancerName"> <summary> The name associated with the LoadBalancer for which the policy is being created. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.PolicyName"> <summary> The name of the load balancer policy being created. The name must be unique within the set of policies for this load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.PolicyTypeName"> <summary> The name of the base policy type being used to create this policy. To get the list of policy types, use the <a>DescribeLoadBalancerPolicyTypes</a> action. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyRequest.PolicyAttributes"> <summary> A list of attributes associated with the policy being created. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyResponse"> <summary> Returns information about the CreateLoadBalancerPolicyResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyResponse.CreateLoadBalancerPolicyResult"> <summary> Gets and sets the CreateLoadBalancerPolicyResult property. The output for the CreateLoadBalancerPolicy action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerPolicyResult"> <summary> <para>The output for the CreateLoadBalancerPolicy action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest"> <summary> Container for the parameters to the CreateLoadBalancer operation. <para> Creates a new load balancer. </para> <para> After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:</para> <ul> <li> <i>us-east-1.elb.amazonaws.com</i> (for the Northern Virginia Region) </li> <li> <i>us-west-1.elb.amazonaws.com</i> (for the Northern California Region) </li> </ul> <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</a> .</para> <para>You can create up to 20 load balancers per region per account.</para> <para>Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:</para> <ul> <li> <i>EC2-Classic</i> <para>For information on creating and managing your load balancers in EC2-Classic, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForEC2.html">Deploy Elastic Load Balancing in Amazon EC2-Classic</a> .</para> </li> <li> <i>EC2-VPC</i> <para>For information on creating and managing your load balancers in EC2-VPC, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html">Deploy Elastic Load Balancing in Amazon VPC</a> .</para> </li> </ul> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.CreateLoadBalancer(Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.#ctor"> <summary> Default constructor for a new CreateLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.#ctor(System.String)"> <summary> Constructs a new CreateLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. The name must be unique within your set of load balancers. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.ElasticLoadBalancing.Model.Listener},System.Collections.Generic.List{System.String})"> <summary> Constructs a new CreateLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. The name must be unique within your set of load balancers. </param> <param name="listeners"> A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol. </param> <param name="availabilityZones"> A list of Availability Zones. At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones. You can later add more Availability Zones after the creation of the load balancer by calling <a>EnableAvailabilityZonesForLoadBalancer</a> action. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithListeners(Amazon.ElasticLoadBalancing.Model.Listener[])"> <summary> Adds elements to the Listeners collection </summary> <param name="listeners">The values to add to the Listeners collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithListeners(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Listener})"> <summary> Adds elements to the Listeners collection </summary> <param name="listeners">The values to add to the Listeners collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithAvailabilityZones(System.String[])"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithSubnets(System.String[])"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithSubnets(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithSecurityGroups(System.String[])"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithSecurityGroups(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.WithScheme(System.String)"> <summary> Sets the Scheme property </summary> <param name="scheme">The value to set for the Scheme property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.LoadBalancerName"> <summary> The name associated with the load balancer. The name must be unique within your set of load balancers. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.Listeners"> <summary> A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.AvailabilityZones"> <summary> A list of Availability Zones. At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones. You can later add more Availability Zones after the creation of the load balancer by calling <a>EnableAvailabilityZonesForLoadBalancer</a> action. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.Subnets"> <summary> A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.SecurityGroups"> <summary> The security groups to assign to your load balancer within your VPC. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerRequest.Scheme"> <summary> The type of a load balancer. By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more informationabout Internet-facing and Internal load balancers, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/vpc-loadbalancer-types.html">Internet-facing and Internal Load Balancers</a>. Specify the value <c>internal</c> for this option to create an internal load balancer with a DNS name that resolves to private IP addresses. <note> This option is only available for load balancers created within EC2-VPC. </note> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerResponse"> <summary> Returns information about the CreateLoadBalancerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerResponse.CreateLoadBalancerResult"> <summary> Gets and sets the CreateLoadBalancerResult property. The output for the CreateLoadBalancer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerResult"> <summary> <para> The output for the CreateLoadBalancer action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerResult.WithDNSName(System.String)"> <summary> Sets the DNSName property </summary> <param name="dNSName">The value to set for the DNSName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CreateLoadBalancerResult.DNSName"> <summary> The DNS name for the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.CrossZoneLoadBalancing"> <summary> <para>The <c>CrossZoneLoadBalancing</c> data type.</para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.CrossZoneLoadBalancing.WithEnabled(System.Boolean)"> <summary> Sets the Enabled property </summary> <param name="enabled">The value to set for the Enabled property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.CrossZoneLoadBalancing.Enabled"> <summary> Specifies whether cross-zone load balancing is enabled for the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest"> <summary> Container for the parameters to the DeleteLoadBalancerListeners operation. <para> Deletes listeners from the load balancer for the specified port. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerListeners(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest.#ctor"> <summary> Default constructor for a new DeleteLoadBalancerListenersRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest.#ctor(System.String,System.Collections.Generic.List{System.Int32})"> <summary> Constructs a new DeleteLoadBalancerListenersRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The mnemonic name associated with the load balancer. </param> <param name="loadBalancerPorts"> The client port number(s) of the load balancer listener(s) to be removed. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest.WithLoadBalancerPorts(System.Int32[])"> <summary> Adds elements to the LoadBalancerPorts collection </summary> <param name="loadBalancerPorts">The values to add to the LoadBalancerPorts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest.WithLoadBalancerPorts(System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Adds elements to the LoadBalancerPorts collection </summary> <param name="loadBalancerPorts">The values to add to the LoadBalancerPorts collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest.LoadBalancerName"> <summary> The mnemonic name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersRequest.LoadBalancerPorts"> <summary> The client port number(s) of the load balancer listener(s) to be removed. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersResponse"> <summary> Returns information about the DeleteLoadBalancerListenersResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersResponse.DeleteLoadBalancerListenersResult"> <summary> Gets and sets the DeleteLoadBalancerListenersResult property. The output for the DeleteLoadBalancerListeners action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerListenersResult"> <summary> <para> The output for the DeleteLoadBalancerListeners action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest"> <summary> Container for the parameters to the DeleteLoadBalancerPolicy operation. <para> Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancerPolicy(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest.#ctor"> <summary> Default constructor for a new DeleteLoadBalancerPolicyRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest.#ctor(System.String,System.String)"> <summary> Constructs a new DeleteLoadBalancerPolicyRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The mnemonic name associated with the load balancer. </param> <param name="policyName"> The mnemonic name for the policy being deleted. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest.LoadBalancerName"> <summary> The mnemonic name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyRequest.PolicyName"> <summary> The mnemonic name for the policy being deleted. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyResponse"> <summary> Returns information about the DeleteLoadBalancerPolicyResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyResponse.DeleteLoadBalancerPolicyResult"> <summary> Gets and sets the DeleteLoadBalancerPolicyResult property. The output for the DeleteLoadBalancerPolicy action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerPolicyResult"> <summary> <para> The output for the DeleteLoadBalancerPolicy action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest"> <summary> Container for the parameters to the DeleteLoadBalancer operation. <para> Deletes the specified load balancer. </para> <para> If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances. </para> <para> To successfully call this API, you must provide the same account credentials as were used to create the load balancer. </para> <para><b>NOTE:</b> By design, if the load balancer does not exist or has already been deleted, a call to DeleteLoadBalancer action still succeeds. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeleteLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest.#ctor"> <summary> Default constructor for a new DeleteLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest.#ctor(System.String)"> <summary> Constructs a new DeleteLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerRequest.LoadBalancerName"> <summary> The name associated with the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerResponse"> <summary> Returns information about the DeleteLoadBalancerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerResponse.DeleteLoadBalancerResult"> <summary> Gets and sets the DeleteLoadBalancerResult property. The output for the DeleteLoadBalancer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeleteLoadBalancerResult"> <summary> <para> The output for the DeleteLoadBalancer action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest"> <summary> Container for the parameters to the DeregisterInstancesFromLoadBalancer operation. <para> Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer. </para> <para> In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">De-register and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para>You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DeregisterInstancesFromLoadBalancer(Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest.#ctor"> <summary> Default constructor for a new DeregisterInstancesFromLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Constructs a new DeregisterInstancesFromLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. </param> <param name="instances"> A list of EC2 instance IDs consisting of all instances to be deregistered. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest.WithInstances(Amazon.ElasticLoadBalancing.Model.Instance[])"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest.LoadBalancerName"> <summary> The name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerRequest.Instances"> <summary> A list of EC2 instance IDs consisting of all instances to be deregistered. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerResponse"> <summary> Returns information about the DeregisterInstancesFromLoadBalancerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerResponse.DeregisterInstancesFromLoadBalancerResult"> <summary> Gets and sets the DeregisterInstancesFromLoadBalancerResult property. The output for the DeregisterInstancesFromLoadBalancer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerResult"> <summary> <para> The output for the DeregisterInstancesFromLoadBalancer action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerResult.WithInstances(Amazon.ElasticLoadBalancing.Model.Instance[])"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerResult.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DeregisterInstancesFromLoadBalancerResult.Instances"> <summary> An updated list of remaining instances registered with the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest"> <summary> Container for the parameters to the DescribeInstanceHealth operation. <para> Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned. </para> <para><b>NOTE:</b> You must provide the same account credentials as those that were used to create the load balancer. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeInstanceHealth(Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest.#ctor"> <summary> Default constructor for a new DescribeInstanceHealthRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest.#ctor(System.String)"> <summary> Constructs a new DescribeInstanceHealthRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name of the load balancer. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest.WithInstances(Amazon.ElasticLoadBalancing.Model.Instance[])"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthRequest.Instances"> <summary> A list of instance IDs whose states are being queried. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthResponse"> <summary> Returns information about the DescribeInstanceHealthResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthResponse.DescribeInstanceHealthResult"> <summary> Gets and sets the DescribeInstanceHealthResult property. The output for the DescribeInstanceHealth action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthResult"> <summary> <para> The output for the DescribeInstanceHealth action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthResult.WithInstanceStates(Amazon.ElasticLoadBalancing.Model.InstanceState[])"> <summary> Adds elements to the InstanceStates collection </summary> <param name="instanceStates">The values to add to the InstanceStates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthResult.WithInstanceStates(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.InstanceState})"> <summary> Adds elements to the InstanceStates collection </summary> <param name="instanceStates">The values to add to the InstanceStates collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeInstanceHealthResult.InstanceStates"> <summary> A list containing health information for the specified instances. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest"> <summary> Container for the parameters to the DescribeLoadBalancerAttributes operation. <para>Returns detailed information about all of the attributes associated with the specified load balancer.</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesRequest.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesResponse"> <summary> Returns information about the DescribeLoadBalancerAttributesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesResponse.DescribeLoadBalancerAttributesResult"> <summary> Gets and sets the DescribeLoadBalancerAttributesResult property. The following element is returned in a structure named DescribeLoadBalancerAttributesResult. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesResult"> <summary> <para>The following element is returned in a structure named <c>DescribeLoadBalancerAttributesResult</c> .</para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesResult.WithLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes)"> <summary> Sets the LoadBalancerAttributes property </summary> <param name="loadBalancerAttributes">The value to set for the LoadBalancerAttributes property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerAttributesResult.LoadBalancerAttributes"> <summary> The load balancer attributes structure. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest"> <summary> Container for the parameters to the DescribeLoadBalancerPolicies operation. <para>Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the 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 the sample policies. The names of the sample policies have the <c>ELBSample-</c> prefix. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicies(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest.WithPolicyNames(System.String[])"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest.WithPolicyNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest.LoadBalancerName"> <summary> The mnemonic name associated with the load balancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesRequest.PolicyNames"> <summary> The names of load balancer policies you've created or Elastic Load Balancing sample policy names. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesResponse"> <summary> Returns information about the DescribeLoadBalancerPoliciesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesResponse.DescribeLoadBalancerPoliciesResult"> <summary> Gets and sets the DescribeLoadBalancerPoliciesResult property. The output for the DescribeLoadBalancerPolicies action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesResult"> <summary> <para>The output for the DescribeLoadBalancerPolicies action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesResult.WithPolicyDescriptions(Amazon.ElasticLoadBalancing.Model.PolicyDescription[])"> <summary> Adds elements to the PolicyDescriptions collection </summary> <param name="policyDescriptions">The values to add to the PolicyDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesResult.WithPolicyDescriptions(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.PolicyDescription})"> <summary> Adds elements to the PolicyDescriptions collection </summary> <param name="policyDescriptions">The values to add to the PolicyDescriptions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPoliciesResult.PolicyDescriptions"> <summary> A list of policy description structures. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest"> <summary> Container for the parameters to the DescribeLoadBalancerPolicyTypes operation. <para> Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancerPolicyTypes(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest.WithPolicyTypeNames(System.String[])"> <summary> Adds elements to the PolicyTypeNames collection </summary> <param name="policyTypeNames">The values to add to the PolicyTypeNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest.WithPolicyTypeNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the PolicyTypeNames collection </summary> <param name="policyTypeNames">The values to add to the PolicyTypeNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesRequest.PolicyTypeNames"> <summary> Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesResponse"> <summary> Returns information about the DescribeLoadBalancerPolicyTypesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesResponse.DescribeLoadBalancerPolicyTypesResult"> <summary> Gets and sets the DescribeLoadBalancerPolicyTypesResult property. The output for the DescribeLoadBalancerPolicyTypes action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesResult"> <summary> <para> The output for the DescribeLoadBalancerPolicyTypes action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesResult.WithPolicyTypeDescriptions(Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription[])"> <summary> Adds elements to the PolicyTypeDescriptions collection </summary> <param name="policyTypeDescriptions">The values to add to the PolicyTypeDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesResult.WithPolicyTypeDescriptions(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription})"> <summary> Adds elements to the PolicyTypeDescriptions collection </summary> <param name="policyTypeDescriptions">The values to add to the PolicyTypeDescriptions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancerPolicyTypesResult.PolicyTypeDescriptions"> <summary> List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest"> <summary> Container for the parameters to the DescribeLoadBalancers operation. <para> Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers. </para> <para><b>NOTE:</b> In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DescribeLoadBalancers(Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest.#ctor"> <summary> Default constructor for a new DescribeLoadBalancersRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Constructs a new DescribeLoadBalancersRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerNames"> A list of load balancer names associated with the account. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest.WithLoadBalancerNames(System.String[])"> <summary> Adds elements to the LoadBalancerNames collection </summary> <param name="loadBalancerNames">The values to add to the LoadBalancerNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest.WithLoadBalancerNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the LoadBalancerNames collection </summary> <param name="loadBalancerNames">The values to add to the LoadBalancerNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest.LoadBalancerNames"> <summary> A list of load balancer names associated with the account. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersRequest.Marker"> <summary> An optional parameter reserved for future use. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResponse"> <summary> Returns information about the DescribeLoadBalancersResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResponse.DescribeLoadBalancersResult"> <summary> Gets and sets the DescribeLoadBalancersResult property. The output for the DescribeLoadBalancers action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResult"> <summary> <para> The output for the DescribeLoadBalancers action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResult.WithLoadBalancerDescriptions(Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription[])"> <summary> Adds elements to the LoadBalancerDescriptions collection </summary> <param name="loadBalancerDescriptions">The values to add to the LoadBalancerDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResult.WithLoadBalancerDescriptions(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription})"> <summary> Adds elements to the LoadBalancerDescriptions collection </summary> <param name="loadBalancerDescriptions">The values to add to the LoadBalancerDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResult.WithNextMarker(System.String)"> <summary> Sets the NextMarker property </summary> <param name="nextMarker">The value to set for the NextMarker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResult.LoadBalancerDescriptions"> <summary> A list of load balancer description structures. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DescribeLoadBalancersResult.NextMarker"> <summary> An optional parameter reserved for future use. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest"> <summary> Container for the parameters to the DetachLoadBalancerFromSubnets operation. <para> Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. </para> <para> After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the <i>OutOfService</i> state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DetachLoadBalancerFromSubnets(Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest.WithSubnets(System.String[])"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest.WithSubnets(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest.LoadBalancerName"> <summary> The name associated with the load balancer to be detached. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsRequest.Subnets"> <summary> A list of subnet IDs to remove from the set of configured subnets for the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsResponse"> <summary> Returns information about the DetachLoadBalancerFromSubnetsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsResponse.DetachLoadBalancerFromSubnetsResult"> <summary> Gets and sets the DetachLoadBalancerFromSubnetsResult property. The output for the DetachLoadBalancerFromSubnets action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsResult"> <summary> <para> The output for the DetachLoadBalancerFromSubnets action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsResult.WithSubnets(System.String[])"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsResult.WithSubnets(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DetachLoadBalancerFromSubnetsResult.Subnets"> <summary> A list of subnet IDs the load balancer is now attached to. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest"> <summary> Container for the parameters to the DisableAvailabilityZonesForLoadBalancer operation. <para> Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer. </para> <para> There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the <i>OutOfService</i> state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing. </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> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.DisableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest.#ctor"> <summary> Default constructor for a new DisableAvailabilityZonesForLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest.#ctor(System.String,System.Collections.Generic.List{System.String})"> <summary> Constructs a new DisableAvailabilityZonesForLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. </param> <param name="availabilityZones"> A list of Availability Zones to be removed from the load balancer. <note> There must be at least one Availability Zone registered with a load balancer at all times. Specified Availability Zones must be in the same region. </note> </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest.WithAvailabilityZones(System.String[])"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest.LoadBalancerName"> <summary> The name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerRequest.AvailabilityZones"> <summary> A list of Availability Zones to be removed from the load balancer. <note> There must be at least one Availability Zone registered with a load balancer at all times. Specified Availability Zones must be in the same region. </note> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerResponse"> <summary> Returns information about the DisableAvailabilityZonesForLoadBalancerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerResponse.DisableAvailabilityZonesForLoadBalancerResult"> <summary> Gets and sets the DisableAvailabilityZonesForLoadBalancerResult property. The output for the DisableAvailabilityZonesForLoadBalancer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerResult"> <summary> <para> The output for the DisableAvailabilityZonesForLoadBalancer action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerResult.WithAvailabilityZones(System.String[])"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerResult.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.DisableAvailabilityZonesForLoadBalancerResult.AvailabilityZones"> <summary> A list of updated Availability Zones for the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DuplicateListenerException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DuplicateListenerException.#ctor(System.String)"> <summary> Constructs a new DuplicateListenerException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DuplicateLoadBalancerNameException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DuplicateLoadBalancerNameException.#ctor(System.String)"> <summary> Constructs a new DuplicateLoadBalancerNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.DuplicatePolicyNameException.#ctor(System.String)"> <summary> Constructs a new DuplicatePolicyNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest"> <summary> Container for the parameters to the EnableAvailabilityZonesForLoadBalancer operation. <para> Adds one or more EC2 Availability Zones to the load balancer. </para> <para> The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. </para> <para><b>NOTE:</b> The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created. </para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_AddLBAvailabilityZone.html">Expand a Load Balanced Application to an Additional Availability Zone</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.EnableAvailabilityZonesForLoadBalancer(Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest.#ctor"> <summary> Default constructor for a new EnableAvailabilityZonesForLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest.#ctor(System.String,System.Collections.Generic.List{System.String})"> <summary> Constructs a new EnableAvailabilityZonesForLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. </param> <param name="availabilityZones"> A list of new Availability Zones for the load balancer. Each Availability Zone must be in the same region as the load balancer. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest.WithAvailabilityZones(System.String[])"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest.LoadBalancerName"> <summary> The name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerRequest.AvailabilityZones"> <summary> A list of new Availability Zones for the load balancer. Each Availability Zone must be in the same region as the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerResponse"> <summary> Returns information about the EnableAvailabilityZonesForLoadBalancerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerResponse.EnableAvailabilityZonesForLoadBalancerResult"> <summary> Gets and sets the EnableAvailabilityZonesForLoadBalancerResult property. The output for the EnableAvailabilityZonesForLoadBalancer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerResult"> <summary> <para> The output for the EnableAvailabilityZonesForLoadBalancer action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerResult.WithAvailabilityZones(System.String[])"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerResult.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.EnableAvailabilityZonesForLoadBalancerResult.AvailabilityZones"> <summary> An updated list of Availability Zones for the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.HealthCheck"> <summary> <para> The HealthCheck data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.HealthCheck.#ctor"> <summary> Default constructor for a new HealthCheck object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.HealthCheck.#ctor(System.String,System.Int32,System.Int32,System.Int32,System.Int32)"> <summary> Constructs a new HealthCheck object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="target"> Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535. <note> TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. SSL is also specified as SSL: port pair, for example, SSL:5000. For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy. The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less. </note> </param> <param name="interval"> Specifies the approximate interval, in seconds, between health checks of an individual instance. </param> <param name="timeout"> Specifies the amount of time, in seconds, during which no response means a failed health probe. <note> This value must be less than the <i>Interval</i> value. </note> </param> <param name="unhealthyThreshold"> Specifies the number of consecutive health probe failures required before moving the instance to the <i>Unhealthy</i> state. </param> <param name="healthyThreshold"> Specifies the number of consecutive health probe successes required before moving the instance to the <i>Healthy</i> state. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.HealthCheck.WithTarget(System.String)"> <summary> Sets the Target property </summary> <param name="target">The value to set for the Target property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.HealthCheck.WithInterval(System.Int32)"> <summary> Sets the Interval property </summary> <param name="interval">The value to set for the Interval property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.HealthCheck.WithTimeout(System.Int32)"> <summary> Sets the Timeout property </summary> <param name="timeout">The value to set for the Timeout property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.HealthCheck.WithUnhealthyThreshold(System.Int32)"> <summary> Sets the UnhealthyThreshold property </summary> <param name="unhealthyThreshold">The value to set for the UnhealthyThreshold property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.HealthCheck.WithHealthyThreshold(System.Int32)"> <summary> Sets the HealthyThreshold property </summary> <param name="healthyThreshold">The value to set for the HealthyThreshold property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.HealthCheck.Target"> <summary> Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535. <note> TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy. SSL is also specified as SSL: port pair, for example, SSL:5000. For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy. The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less. </note> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.HealthCheck.Interval"> <summary> Specifies the approximate interval, in seconds, between health checks of an individual instance. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 300</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.HealthCheck.Timeout"> <summary> Specifies the amount of time, in seconds, during which no response means a failed health probe. <note> This value must be less than the <i>Interval</i> value. </note> <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 300</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.HealthCheck.UnhealthyThreshold"> <summary> Specifies the number of consecutive health probe failures required before moving the instance to the <i>Unhealthy</i> state. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>2 - 10</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.HealthCheck.HealthyThreshold"> <summary> Specifies the number of consecutive health probe successes required before moving the instance to the <i>Healthy</i> state. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>2 - 10</description> </item> </list> </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Instance"> <summary> <para> The Instance data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Instance.#ctor"> <summary> Default constructor for a new Instance object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Instance.#ctor(System.String)"> <summary> Constructs a new Instance object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="instanceId"> Provides an EC2 instance ID. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Instance.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Instance.InstanceId"> <summary> Provides an EC2 instance ID. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.InstanceState"> <summary> <para> The InstanceState data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InstanceState.#ctor"> <summary> Default constructor for a new InstanceState object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InstanceState.WithInstanceId(System.String)"> <summary> Sets the InstanceId property </summary> <param name="instanceId">The value to set for the InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InstanceState.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InstanceState.WithReasonCode(System.String)"> <summary> Sets the ReasonCode property </summary> <param name="reasonCode">The value to set for the ReasonCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InstanceState.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.InstanceState.InstanceId"> <summary> Provides an EC2 instance ID. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.InstanceState.State"> <summary> Specifies the current state of the instance. Valid value: <c>InService</c>|<c>OutOfService</c> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.InstanceState.ReasonCode"> <summary> Provides information about the cause of <i>OutOfService</i> instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the load balancer. Valid value: <c>ELB</c>|<c>Instance</c>|<c>N/A</c> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.InstanceState.Description"> <summary> Provides a description of the instance state. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.AccessLogUnmarshaller"> <summary> AccessLog Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.AppCookieStickinessPolicyUnmarshaller"> <summary> AppCookieStickinessPolicy Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ApplySecurityGroupsToLoadBalancerRequestMarshaller"> <summary> Apply Security Groups To Load Balancer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ApplySecurityGroupsToLoadBalancerResponseUnmarshaller"> <summary> Response Unmarshaller for ApplySecurityGroupsToLoadBalancer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ApplySecurityGroupsToLoadBalancerResultUnmarshaller"> <summary> ApplySecurityGroupsToLoadBalancerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.AttachLoadBalancerToSubnetsRequestMarshaller"> <summary> Attach Load Balancer To Subnets Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.AttachLoadBalancerToSubnetsResponseUnmarshaller"> <summary> Response Unmarshaller for AttachLoadBalancerToSubnets operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.AttachLoadBalancerToSubnetsResultUnmarshaller"> <summary> AttachLoadBalancerToSubnetsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.BackendServerDescriptionUnmarshaller"> <summary> BackendServerDescription Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ConfigureHealthCheckRequestMarshaller"> <summary> Configure Health Check Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ConfigureHealthCheckResponseUnmarshaller"> <summary> Response Unmarshaller for ConfigureHealthCheck operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ConfigureHealthCheckResultUnmarshaller"> <summary> ConfigureHealthCheckResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ConnectionDrainingUnmarshaller"> <summary> ConnectionDraining Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateAppCookieStickinessPolicyRequestMarshaller"> <summary> Create App Cookie Stickiness Policy Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateAppCookieStickinessPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for CreateAppCookieStickinessPolicy operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateAppCookieStickinessPolicyResultUnmarshaller"> <summary> CreateAppCookieStickinessPolicyResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLBCookieStickinessPolicyRequestMarshaller"> <summary> Create L B Cookie Stickiness Policy Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLBCookieStickinessPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLBCookieStickinessPolicy operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLBCookieStickinessPolicyResultUnmarshaller"> <summary> CreateLBCookieStickinessPolicyResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerListenersRequestMarshaller"> <summary> Create Load Balancer Listeners Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerListenersResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLoadBalancerListeners operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerListenersResultUnmarshaller"> <summary> CreateLoadBalancerListenersResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerPolicyRequestMarshaller"> <summary> Create Load Balancer Policy Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLoadBalancerPolicy operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerPolicyResultUnmarshaller"> <summary> CreateLoadBalancerPolicyResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerRequestMarshaller"> <summary> Create Load Balancer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLoadBalancer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CreateLoadBalancerResultUnmarshaller"> <summary> CreateLoadBalancerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.CrossZoneLoadBalancingUnmarshaller"> <summary> CrossZoneLoadBalancing Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerListenersRequestMarshaller"> <summary> Delete Load Balancer Listeners Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerListenersResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLoadBalancerListeners operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerListenersResultUnmarshaller"> <summary> DeleteLoadBalancerListenersResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerPolicyRequestMarshaller"> <summary> Delete Load Balancer Policy Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLoadBalancerPolicy operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerPolicyResultUnmarshaller"> <summary> DeleteLoadBalancerPolicyResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerRequestMarshaller"> <summary> Delete Load Balancer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLoadBalancer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeleteLoadBalancerResultUnmarshaller"> <summary> DeleteLoadBalancerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeregisterInstancesFromLoadBalancerRequestMarshaller"> <summary> Deregister Instances From Load Balancer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeregisterInstancesFromLoadBalancerResponseUnmarshaller"> <summary> Response Unmarshaller for DeregisterInstancesFromLoadBalancer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DeregisterInstancesFromLoadBalancerResultUnmarshaller"> <summary> DeregisterInstancesFromLoadBalancerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeInstanceHealthRequestMarshaller"> <summary> Describe Instance Health Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeInstanceHealthResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeInstanceHealth operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeInstanceHealthResultUnmarshaller"> <summary> DescribeInstanceHealthResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerAttributesRequestMarshaller"> <summary> Describe Load Balancer Attributes Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerAttributesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLoadBalancerAttributes operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerAttributesResultUnmarshaller"> <summary> DescribeLoadBalancerAttributesResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerPoliciesRequestMarshaller"> <summary> Describe Load Balancer Policies Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerPoliciesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLoadBalancerPolicies operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerPoliciesResultUnmarshaller"> <summary> DescribeLoadBalancerPoliciesResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerPolicyTypesRequestMarshaller"> <summary> Describe Load Balancer Policy Types Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerPolicyTypesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLoadBalancerPolicyTypes operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancerPolicyTypesResultUnmarshaller"> <summary> DescribeLoadBalancerPolicyTypesResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancersRequestMarshaller"> <summary> Describe Load Balancers Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLoadBalancers operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DescribeLoadBalancersResultUnmarshaller"> <summary> DescribeLoadBalancersResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DetachLoadBalancerFromSubnetsRequestMarshaller"> <summary> Detach Load Balancer From Subnets Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DetachLoadBalancerFromSubnetsResponseUnmarshaller"> <summary> Response Unmarshaller for DetachLoadBalancerFromSubnets operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DetachLoadBalancerFromSubnetsResultUnmarshaller"> <summary> DetachLoadBalancerFromSubnetsResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DisableAvailabilityZonesForLoadBalancerRequestMarshaller"> <summary> Disable Availability Zones For Load Balancer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DisableAvailabilityZonesForLoadBalancerResponseUnmarshaller"> <summary> Response Unmarshaller for DisableAvailabilityZonesForLoadBalancer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.DisableAvailabilityZonesForLoadBalancerResultUnmarshaller"> <summary> DisableAvailabilityZonesForLoadBalancerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.EnableAvailabilityZonesForLoadBalancerRequestMarshaller"> <summary> Enable Availability Zones For Load Balancer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.EnableAvailabilityZonesForLoadBalancerResponseUnmarshaller"> <summary> Response Unmarshaller for EnableAvailabilityZonesForLoadBalancer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.EnableAvailabilityZonesForLoadBalancerResultUnmarshaller"> <summary> EnableAvailabilityZonesForLoadBalancerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.HealthCheckUnmarshaller"> <summary> HealthCheck Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.InstanceStateUnmarshaller"> <summary> InstanceState Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.InstanceUnmarshaller"> <summary> Instance Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.LBCookieStickinessPolicyUnmarshaller"> <summary> LBCookieStickinessPolicy Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ListenerDescriptionUnmarshaller"> <summary> ListenerDescription Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ListenerUnmarshaller"> <summary> Listener Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.LoadBalancerAttributesUnmarshaller"> <summary> LoadBalancerAttributes Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.LoadBalancerDescriptionUnmarshaller"> <summary> LoadBalancerDescription Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ModifyLoadBalancerAttributesRequestMarshaller"> <summary> Modify Load Balancer Attributes Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ModifyLoadBalancerAttributesResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyLoadBalancerAttributes operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.ModifyLoadBalancerAttributesResultUnmarshaller"> <summary> ModifyLoadBalancerAttributesResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.PoliciesUnmarshaller"> <summary> Policies Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.PolicyAttributeDescriptionUnmarshaller"> <summary> PolicyAttributeDescription Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.PolicyAttributeTypeDescriptionUnmarshaller"> <summary> PolicyAttributeTypeDescription Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.PolicyDescriptionUnmarshaller"> <summary> PolicyDescription Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.PolicyTypeDescriptionUnmarshaller"> <summary> PolicyTypeDescription Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.RegisterInstancesWithLoadBalancerRequestMarshaller"> <summary> Register Instances With Load Balancer Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.RegisterInstancesWithLoadBalancerResponseUnmarshaller"> <summary> Response Unmarshaller for RegisterInstancesWithLoadBalancer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.RegisterInstancesWithLoadBalancerResultUnmarshaller"> <summary> RegisterInstancesWithLoadBalancerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerListenerSSLCertificateRequestMarshaller"> <summary> Set Load Balancer Listener S S L Certificate Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerListenerSSLCertificateResponseUnmarshaller"> <summary> Response Unmarshaller for SetLoadBalancerListenerSSLCertificate operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerListenerSSLCertificateResultUnmarshaller"> <summary> SetLoadBalancerListenerSSLCertificateResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerPoliciesForBackendServerRequestMarshaller"> <summary> Set Load Balancer Policies For Backend Server Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerPoliciesForBackendServerResponseUnmarshaller"> <summary> Response Unmarshaller for SetLoadBalancerPoliciesForBackendServer operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerPoliciesForBackendServerResultUnmarshaller"> <summary> SetLoadBalancerPoliciesForBackendServerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerPoliciesOfListenerRequestMarshaller"> <summary> Set Load Balancer Policies Of Listener Request Marshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerPoliciesOfListenerResponseUnmarshaller"> <summary> Response Unmarshaller for SetLoadBalancerPoliciesOfListener operation </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SetLoadBalancerPoliciesOfListenerResultUnmarshaller"> <summary> SetLoadBalancerPoliciesOfListenerResult Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Internal.MarshallTransformations.SourceSecurityGroupUnmarshaller"> <summary> SourceSecurityGroup Unmarshaller </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InvalidConfigurationRequestException.#ctor(System.String)"> <summary> Constructs a new InvalidConfigurationRequestException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InvalidInstanceException.#ctor(System.String)"> <summary> Constructs a new InvalidInstanceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.InvalidSchemeException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InvalidSchemeException.#ctor(System.String)"> <summary> Constructs a new InvalidSchemeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InvalidSecurityGroupException.#ctor(System.String)"> <summary> Constructs a new InvalidSecurityGroupException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.InvalidSubnetException.#ctor(System.String)"> <summary> Constructs a new InvalidSubnetException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy"> <summary> <para>The LBCookieStickinessPolicy data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy.#ctor"> <summary> Default constructor for a new LBCookieStickinessPolicy object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy.#ctor(System.String,System.Int64)"> <summary> Constructs a new LBCookieStickinessPolicy object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="policyName"> The name for the policy being created. The name must be unique within the set of policies for this load balancer. </param> <param name="cookieExpirationPeriod"> The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy.WithCookieExpirationPeriod(System.Int64)"> <summary> Sets the CookieExpirationPeriod property </summary> <param name="cookieExpirationPeriod">The value to set for the CookieExpirationPeriod property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy.PolicyName"> <summary> The name for the policy being created. The name must be unique within the set of policies for this load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy.CookieExpirationPeriod"> <summary> The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Listener"> <summary> <para> The Listener data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Listener.#ctor"> <summary> Default constructor for a new Listener object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Listener.#ctor(System.String,System.Int32,System.Int32)"> <summary> Constructs a new Listener object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="protocol"> Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer. </param> <param name="loadBalancerPort"> Specifies the external load balancer port number. This property cannot be modified for the life of the load balancer. </param> <param name="instancePort"> Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the load balancer. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Listener.WithProtocol(System.String)"> <summary> Sets the Protocol property </summary> <param name="protocol">The value to set for the Protocol property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Listener.WithLoadBalancerPort(System.Int32)"> <summary> Sets the LoadBalancerPort property </summary> <param name="loadBalancerPort">The value to set for the LoadBalancerPort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Listener.WithInstanceProtocol(System.String)"> <summary> Sets the InstanceProtocol property </summary> <param name="instanceProtocol">The value to set for the InstanceProtocol property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Listener.WithInstancePort(System.Int32)"> <summary> Sets the InstancePort property </summary> <param name="instancePort">The value to set for the InstancePort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Listener.WithSSLCertificateId(System.String)"> <summary> Sets the SSLCertificateId property </summary> <param name="sSLCertificateId">The value to set for the SSLCertificateId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Listener.Protocol"> <summary> Specifies the load balancer transport protocol to use for routing - HTTP, HTTPS, TCP or SSL. This property cannot be modified for the life of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Listener.LoadBalancerPort"> <summary> Specifies the external load balancer port number. This property cannot be modified for the life of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Listener.InstanceProtocol"> <summary> Specifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL. This property cannot be modified for the life of the load balancer. <note> If the front-end protocol is HTTP or HTTPS, <c>InstanceProtocol</c> has to be at the same protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. </note> <note> If there is another listener with the same <c>InstancePort</c> whose <c>InstanceProtocol</c> is secure, i.e., HTTPS or SSL, the listener's <c>InstanceProtocol</c> has to be secure, i.e., HTTPS or SSL. If there is another listener with the same <c>InstancePort</c> whose <c>InstanceProtocol</c> is HTTP or TCP, the listener's <c>InstanceProtocol</c> must be either HTTP or TCP. </note> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Listener.InstancePort"> <summary> Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the load balancer. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 65535</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Listener.SSLCertificateId"> <summary> The ARN string of the server certificate. To get the ARN of the server certificate, call the AWS Identity and Access Management <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/index.html?API_UploadServerCertificate.html">UploadServerCertificate </a> API. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ListenerDescription"> <summary> <para> The ListenerDescription data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ListenerDescription.#ctor"> <summary> Default constructor for a new ListenerDescription object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ListenerDescription.WithListener(Amazon.ElasticLoadBalancing.Model.Listener)"> <summary> Sets the Listener property </summary> <param name="listener">The value to set for the Listener property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ListenerDescription.WithPolicyNames(System.String[])"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ListenerDescription.WithPolicyNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ListenerDescription.Listener"> <summary> The Listener data type. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ListenerDescription.PolicyNames"> <summary> A list of policies enabled for this listener. An empty list indicates that no policies are enabled. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ListenerNotFoundException.#ctor(System.String)"> <summary> Constructs a new ListenerNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributeNotFoundException.#ctor(System.String)"> <summary> Constructs a new LoadBalancerAttributeNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes"> <summary> <para>The <c>LoadBalancerAttributes</c> data type.</para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes.WithCrossZoneLoadBalancing(Amazon.ElasticLoadBalancing.Model.CrossZoneLoadBalancing)"> <summary> Sets the CrossZoneLoadBalancing property </summary> <param name="crossZoneLoadBalancing">The value to set for the CrossZoneLoadBalancing property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes.WithAccessLog(Amazon.ElasticLoadBalancing.Model.AccessLog)"> <summary> Sets the AccessLog property </summary> <param name="accessLog">The value to set for the AccessLog property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes.WithConnectionDraining(Amazon.ElasticLoadBalancing.Model.ConnectionDraining)"> <summary> Sets the ConnectionDraining property </summary> <param name="connectionDraining">The value to set for the ConnectionDraining property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes.CrossZoneLoadBalancing"> <summary> The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-disable-crosszone-lb.html">Enable Cross-Zone Load Balancing</a>. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes.AccessLog"> <summary> The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket you specify. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-access-logs.html">Enable Access Logs</a>. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes.ConnectionDraining"> <summary> The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance. For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/config-conn-drain.html">Enable Connection Draining</a>. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription"> <summary> <para> Contains the result of a successful invocation of DescribeLoadBalancers. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.#ctor"> <summary> Default constructor for a new LoadBalancerDescription object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithDNSName(System.String)"> <summary> Sets the DNSName property </summary> <param name="dNSName">The value to set for the DNSName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithCanonicalHostedZoneName(System.String)"> <summary> Sets the CanonicalHostedZoneName property </summary> <param name="canonicalHostedZoneName">The value to set for the CanonicalHostedZoneName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithCanonicalHostedZoneNameID(System.String)"> <summary> Sets the CanonicalHostedZoneNameID property </summary> <param name="canonicalHostedZoneNameID">The value to set for the CanonicalHostedZoneNameID property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithListenerDescriptions(Amazon.ElasticLoadBalancing.Model.ListenerDescription[])"> <summary> Adds elements to the ListenerDescriptions collection </summary> <param name="listenerDescriptions">The values to add to the ListenerDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithListenerDescriptions(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.ListenerDescription})"> <summary> Adds elements to the ListenerDescriptions collection </summary> <param name="listenerDescriptions">The values to add to the ListenerDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithPolicies(Amazon.ElasticLoadBalancing.Model.Policies)"> <summary> Sets the Policies property </summary> <param name="policies">The value to set for the Policies property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithBackendServerDescriptions(Amazon.ElasticLoadBalancing.Model.BackendServerDescription[])"> <summary> Adds elements to the BackendServerDescriptions collection </summary> <param name="backendServerDescriptions">The values to add to the BackendServerDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithBackendServerDescriptions(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.BackendServerDescription})"> <summary> Adds elements to the BackendServerDescriptions collection </summary> <param name="backendServerDescriptions">The values to add to the BackendServerDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithAvailabilityZones(System.String[])"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithAvailabilityZones(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the AvailabilityZones collection </summary> <param name="availabilityZones">The values to add to the AvailabilityZones collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithSubnets(System.String[])"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithSubnets(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Subnets collection </summary> <param name="subnets">The values to add to the Subnets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithVPCId(System.String)"> <summary> Sets the VPCId property </summary> <param name="vPCId">The value to set for the VPCId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithInstances(Amazon.ElasticLoadBalancing.Model.Instance[])"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithHealthCheck(Amazon.ElasticLoadBalancing.Model.HealthCheck)"> <summary> Sets the HealthCheck property </summary> <param name="healthCheck">The value to set for the HealthCheck property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithSourceSecurityGroup(Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup)"> <summary> Sets the SourceSecurityGroup property </summary> <param name="sourceSecurityGroup">The value to set for the SourceSecurityGroup property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithSecurityGroups(System.String[])"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithSecurityGroups(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the SecurityGroups collection </summary> <param name="securityGroups">The values to add to the SecurityGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithCreatedTime(System.DateTime)"> <summary> Sets the CreatedTime property </summary> <param name="createdTime">The value to set for the CreatedTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.WithScheme(System.String)"> <summary> Sets the Scheme property </summary> <param name="scheme">The value to set for the Scheme property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.LoadBalancerName"> <summary> Specifies the name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.DNSName"> <summary> Specifies the external DNS name associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.CanonicalHostedZoneName"> <summary> Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. For information on how to associate your load balancer with a hosted zone, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-domain-names-with-elb.html">Using Domain Names With Elastic Load Balancing</a> in the <i>Elastic Load Balancing Developer Guide</i>. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.CanonicalHostedZoneNameID"> <summary> Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. For information on how to associate or disassociate your load balancer with a hosted zone, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-domain-names-with-elb.html">Using Domain Names With Elastic Load Balancing</a> in the <i>Elastic Load Balancing Developer Guide</i>. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.ListenerDescriptions"> <summary> LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.Policies"> <summary> Provides a list of policies defined for the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.BackendServerDescriptions"> <summary> Contains a list of back-end server descriptions. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.AvailabilityZones"> <summary> Specifies a list of Availability Zones. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.Subnets"> <summary> Provides a list of VPC subnet IDs for the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.VPCId"> <summary> Provides the ID of the VPC attached to the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.Instances"> <summary> Provides a list of EC2 instance IDs for the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.HealthCheck"> <summary> Specifies information regarding the various health probes conducted on the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.SourceSecurityGroup"> <summary> The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.SecurityGroups"> <summary> The security groups the load balancer is a member of (VPC only). </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.CreatedTime"> <summary> Provides the date and time the load balancer was created. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.LoadBalancerDescription.Scheme"> <summary> Specifies the type of load balancer. If the <c>Scheme</c> is <c>internet-facing</c>, the load balancer has a publicly resolvable DNS name that resolves to public IP addresses. If the <c>Scheme</c> is <c>internal</c>, the load balancer has a publicly resolvable DNS name that resolves to private IP addresses. This option is only available for load balancers attached to an Amazon VPC. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.LoadBalancerNotFoundException.#ctor(System.String)"> <summary> Constructs a new LoadBalancerNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest"> <summary> Container for the parameters to the ModifyLoadBalancerAttributes operation. <para>Modifies the attributes of a specified load balancer.</para> <para>You can modify the load balancer attributes, such as <c>AccessLogs</c> , <c>ConnectionDraining</c> , and <c>CrossZoneLoadBalancing</c> by either enabling or disabling them.</para> <para>For information on cross-zone load balancing, see <b>Request Routing</b> and for information on connection draining, see <b>Connection Draining</b> in the <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html">Concepts</a> section of the <i>Elastic Load Balancer Developer Guide</i> . For information on access logs, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/access-log-collection.html">Access Logs</a> .</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.ModifyLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest.WithLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes)"> <summary> Sets the LoadBalancerAttributes property </summary> <param name="loadBalancerAttributes">The value to set for the LoadBalancerAttributes property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesRequest.LoadBalancerAttributes"> <summary> Attributes of the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResponse"> <summary> Returns information about the ModifyLoadBalancerAttributesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResponse.ModifyLoadBalancerAttributesResult"> <summary> Gets and sets the ModifyLoadBalancerAttributesResult property. The output for the ModifyLoadBalancerAttributes action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResult"> <summary> <para>The output for the ModifyLoadBalancerAttributes action.</para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResult.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResult.WithLoadBalancerAttributes(Amazon.ElasticLoadBalancing.Model.LoadBalancerAttributes)"> <summary> Sets the LoadBalancerAttributes property </summary> <param name="loadBalancerAttributes">The value to set for the LoadBalancerAttributes property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResult.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.ModifyLoadBalancerAttributesResult.LoadBalancerAttributes"> <summary> The <c>LoadBalancerAttributes</c> data type. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.Policies"> <summary> <para> The policies data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Policies.#ctor"> <summary> Default constructor for a new Policies object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Policies.WithAppCookieStickinessPolicies(Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy[])"> <summary> Adds elements to the AppCookieStickinessPolicies collection </summary> <param name="appCookieStickinessPolicies">The values to add to the AppCookieStickinessPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Policies.WithAppCookieStickinessPolicies(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.AppCookieStickinessPolicy})"> <summary> Adds elements to the AppCookieStickinessPolicies collection </summary> <param name="appCookieStickinessPolicies">The values to add to the AppCookieStickinessPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Policies.WithLBCookieStickinessPolicies(Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy[])"> <summary> Adds elements to the LBCookieStickinessPolicies collection </summary> <param name="lBCookieStickinessPolicies">The values to add to the LBCookieStickinessPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Policies.WithLBCookieStickinessPolicies(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.LBCookieStickinessPolicy})"> <summary> Adds elements to the LBCookieStickinessPolicies collection </summary> <param name="lBCookieStickinessPolicies">The values to add to the LBCookieStickinessPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Policies.WithOtherPolicies(System.String[])"> <summary> Adds elements to the OtherPolicies collection </summary> <param name="otherPolicies">The values to add to the OtherPolicies collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.Policies.WithOtherPolicies(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the OtherPolicies collection </summary> <param name="otherPolicies">The values to add to the OtherPolicies collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Policies.AppCookieStickinessPolicies"> <summary> A list of the <a>AppCookieStickinessPolicy</a> objects created with <a>CreateAppCookieStickinessPolicy</a>. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Policies.LBCookieStickinessPolicies"> <summary> A list of <a>LBCookieStickinessPolicy</a> objects created with <a>CreateAppCookieStickinessPolicy</a>. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.Policies.OtherPolicies"> <summary> A list of policy names other than the stickiness policies. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.PolicyAttribute"> <summary> <para> The PolicyAttribute data type. This data type contains a key/value pair that defines properties of a specific policy. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttribute.#ctor"> <summary> Default constructor for a new PolicyAttribute object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttribute.#ctor(System.String,System.String)"> <summary> Constructs a new PolicyAttribute object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="attributeName"> The name of the attribute associated with the policy. </param> <param name="attributeValue"> The value of the attribute associated with the policy. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttribute.WithAttributeName(System.String)"> <summary> Sets the AttributeName property </summary> <param name="attributeName">The value to set for the AttributeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttribute.WithAttributeValue(System.String)"> <summary> Sets the AttributeValue property </summary> <param name="attributeValue">The value to set for the AttributeValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttribute.AttributeName"> <summary> The name of the attribute associated with the policy. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttribute.AttributeValue"> <summary> The value of the attribute associated with the policy. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.PolicyAttributeDescription"> <summary> <para> The <c>PolicyAttributeDescription</c> data type. This data type is used to describe the attributes and values associated with a policy. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttributeDescription.WithAttributeName(System.String)"> <summary> Sets the AttributeName property </summary> <param name="attributeName">The value to set for the AttributeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttributeDescription.WithAttributeValue(System.String)"> <summary> Sets the AttributeValue property </summary> <param name="attributeValue">The value to set for the AttributeValue property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttributeDescription.AttributeName"> <summary> The name of the attribute associated with the policy. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttributeDescription.AttributeValue"> <summary> The value of the attribute associated with the policy. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription"> <summary> <para> The <c>PolicyAttributeTypeDescription</c> data type. This data type is used to describe values that are acceptable for the policy attribute. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.WithAttributeName(System.String)"> <summary> Sets the AttributeName property </summary> <param name="attributeName">The value to set for the AttributeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.WithAttributeType(System.String)"> <summary> Sets the AttributeType property </summary> <param name="attributeType">The value to set for the AttributeType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.WithDefaultValue(System.String)"> <summary> Sets the DefaultValue property </summary> <param name="defaultValue">The value to set for the DefaultValue property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.WithCardinality(System.String)"> <summary> Sets the Cardinality property </summary> <param name="cardinality">The value to set for the Cardinality property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.AttributeName"> <summary> The name of the attribute associated with the policy type. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.AttributeType"> <summary> The type of attribute. For example, Boolean, Integer, etc. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.Description"> <summary> A human-readable description of the attribute. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.DefaultValue"> <summary> The default value of the attribute, if applicable. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription.Cardinality"> <summary> The cardinality of the attribute. Valid Values: <ul> <li>ONE(1) : Single value required</li> <li>ZERO_OR_ONE(0..1) : Up to one value can be supplied</li> <li>ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed</li> <li>ONE_OR_MORE(1..*0) : Required. Multiple values are allowed</li> </ul> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.PolicyDescription"> <summary> <para> The <c>PolicyDescription</c> data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyDescription.WithPolicyName(System.String)"> <summary> Sets the PolicyName property </summary> <param name="policyName">The value to set for the PolicyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyDescription.WithPolicyTypeName(System.String)"> <summary> Sets the PolicyTypeName property </summary> <param name="policyTypeName">The value to set for the PolicyTypeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyDescription.WithPolicyAttributeDescriptions(Amazon.ElasticLoadBalancing.Model.PolicyAttributeDescription[])"> <summary> Adds elements to the PolicyAttributeDescriptions collection </summary> <param name="policyAttributeDescriptions">The values to add to the PolicyAttributeDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyDescription.WithPolicyAttributeDescriptions(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.PolicyAttributeDescription})"> <summary> Adds elements to the PolicyAttributeDescriptions collection </summary> <param name="policyAttributeDescriptions">The values to add to the PolicyAttributeDescriptions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyDescription.PolicyName"> <summary> The name of the policy associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyDescription.PolicyTypeName"> <summary> The name of the policy type associated with the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyDescription.PolicyAttributeDescriptions"> <summary> A list of policy attribute description structures. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyNotFoundException.#ctor(System.String)"> <summary> Constructs a new PolicyNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription"> <summary> <para> The PolicyTypeDescription data type. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription.WithPolicyTypeName(System.String)"> <summary> Sets the PolicyTypeName property </summary> <param name="policyTypeName">The value to set for the PolicyTypeName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription.WithPolicyAttributeTypeDescriptions(Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription[])"> <summary> Adds elements to the PolicyAttributeTypeDescriptions collection </summary> <param name="policyAttributeTypeDescriptions">The values to add to the PolicyAttributeTypeDescriptions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription.WithPolicyAttributeTypeDescriptions(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.PolicyAttributeTypeDescription})"> <summary> Adds elements to the PolicyAttributeTypeDescriptions collection </summary> <param name="policyAttributeTypeDescriptions">The values to add to the PolicyAttributeTypeDescriptions collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription.PolicyTypeName"> <summary> The name of the policy type. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription.Description"> <summary> A human-readable description of the policy type. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.PolicyTypeDescription.PolicyAttributeTypeDescriptions"> <summary> The description of the policy attributes associated with the load balancer policies defined by the Elastic Load Balancing service. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.PolicyTypeNotFoundException.#ctor(System.String)"> <summary> Constructs a new PolicyTypeNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest"> <summary> Container for the parameters to the RegisterInstancesWithLoadBalancer operation. <para> Adds new instances to the load balancer. </para> <para> Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the <i>OutOfService</i> state. It will move to the <i>InService</i> state when the Availability Zone is added to the load balancer. </para> <para>When an instance registered with a load balancer is stopped and then restarted, 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 de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.</para> <para>For more information, see <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html">De-register and Register Amazon EC2 Instances</a> in the <i>Elastic Load Balancing Developer Guide</i> .</para> <para><b>NOTE:</b> In order for this call to be successful, you must provide the same account credentials as those that were used to create the load balancer. </para> <para><b>NOTE:</b> Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly. </para> <para>You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.RegisterInstancesWithLoadBalancer(Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest.#ctor"> <summary> Default constructor for a new RegisterInstancesWithLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Constructs a new RegisterInstancesWithLoadBalancerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name associated with the load balancer. The name must be unique within your set of load balancers. </param> <param name="instances"> A list of instance IDs that should be registered with the load balancer. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest.WithInstances(Amazon.ElasticLoadBalancing.Model.Instance[])"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest.LoadBalancerName"> <summary> The name associated with the load balancer. The name must be unique within your set of load balancers. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerRequest.Instances"> <summary> A list of instance IDs that should be registered with the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerResponse"> <summary> Returns information about the RegisterInstancesWithLoadBalancerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerResponse.RegisterInstancesWithLoadBalancerResult"> <summary> Gets and sets the RegisterInstancesWithLoadBalancerResult property. The output for the RegisterInstancesWithLoadBalancer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerResult"> <summary> <para> The output for the RegisterInstancesWithLoadBalancer action. </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerResult.WithInstances(Amazon.ElasticLoadBalancing.Model.Instance[])"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerResult.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticLoadBalancing.Model.Instance})"> <summary> Adds elements to the Instances collection </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.RegisterInstancesWithLoadBalancerResult.Instances"> <summary> An updated list of instances for the load balancer. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest"> <summary> Container for the parameters to the SetLoadBalancerListenerSSLCertificate operation. <para> 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> <para>For more information on 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> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerListenerSSLCertificate(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.#ctor"> <summary> Default constructor for a new SetLoadBalancerListenerSSLCertificateRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.#ctor(System.String,System.Int32,System.String)"> <summary> Constructs a new SetLoadBalancerListenerSSLCertificateRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name of the load balancer. </param> <param name="loadBalancerPort"> The port that uses the specified SSL certificate. </param> <param name="sSLCertificateId"> The Amazon Resource Number (ARN) of the SSL certificate chain to use. For more information on SSL certificates, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html"> Managing Server Certificates</a> in the <i>AWS Identity and Access Management User Guide</i>. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.WithLoadBalancerPort(System.Int32)"> <summary> Sets the LoadBalancerPort property </summary> <param name="loadBalancerPort">The value to set for the LoadBalancerPort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.WithSSLCertificateId(System.String)"> <summary> Sets the SSLCertificateId property </summary> <param name="sSLCertificateId">The value to set for the SSLCertificateId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.LoadBalancerPort"> <summary> The port that uses the specified SSL certificate. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateRequest.SSLCertificateId"> <summary> The Amazon Resource Number (ARN) of the SSL certificate chain to use. For more information on SSL certificates, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html"> Managing Server Certificates</a> in the <i>AWS Identity and Access Management User Guide</i>. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateResponse"> <summary> Returns information about the SetLoadBalancerListenerSSLCertificateResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateResponse.SetLoadBalancerListenerSSLCertificateResult"> <summary> Gets and sets the SetLoadBalancerListenerSSLCertificateResult property. The output for the SetLoadBalancerListenerSSLCertificate action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerListenerSSLCertificateResult"> <summary> <para> The output for the SetLoadBalancerListenerSSLCertificate action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest"> <summary> Container for the parameters to the SetLoadBalancerPoliciesForBackendServer operation. <para> Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. 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> <para><b>NOTE:</b> The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable. </para> <para>You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.</para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesForBackendServer(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest.WithInstancePort(System.Int32)"> <summary> Sets the InstancePort property </summary> <param name="instancePort">The value to set for the InstancePort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest.WithPolicyNames(System.String[])"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest.WithPolicyNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest.LoadBalancerName"> <summary> The mnemonic name associated with the load balancer. This name must be unique within the set of your load balancers. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest.InstancePort"> <summary> The port number associated with the back-end server. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerRequest.PolicyNames"> <summary> List of policy names to be set. If the list is empty, then all current polices are removed from the back-end server. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerResponse"> <summary> Returns information about the SetLoadBalancerPoliciesForBackendServerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerResponse.SetLoadBalancerPoliciesForBackendServerResult"> <summary> Gets and sets the SetLoadBalancerPoliciesForBackendServerResult property. The output for the SetLoadBalancerPoliciesForBackendServer action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesForBackendServerResult"> <summary> <para> The output for the SetLoadBalancerPoliciesForBackendServer action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest"> <summary> Container for the parameters to the SetLoadBalancerPoliciesOfListener operation. <para> Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener. </para> </summary> <seealso cref="M:Amazon.ElasticLoadBalancing.AmazonElasticLoadBalancing.SetLoadBalancerPoliciesOfListener(Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest)"/> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.#ctor"> <summary> Default constructor for a new SetLoadBalancerPoliciesOfListenerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize this object after creating it. </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.#ctor(System.String,System.Int32,System.Collections.Generic.List{System.String})"> <summary> Constructs a new SetLoadBalancerPoliciesOfListenerRequest object. Callers should use the properties or fluent setter (With...) methods to initialize any additional object members. </summary> <param name="loadBalancerName"> The name of the load balancer. </param> <param name="loadBalancerPort"> The external port of the load balancer to associate the policy. </param> <param name="policyNames"> List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener. </param> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.WithLoadBalancerName(System.String)"> <summary> Sets the LoadBalancerName property </summary> <param name="loadBalancerName">The value to set for the LoadBalancerName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.WithLoadBalancerPort(System.Int32)"> <summary> Sets the LoadBalancerPort property </summary> <param name="loadBalancerPort">The value to set for the LoadBalancerPort property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.WithPolicyNames(System.String[])"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.WithPolicyNames(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the PolicyNames collection </summary> <param name="policyNames">The values to add to the PolicyNames collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.LoadBalancerName"> <summary> The name of the load balancer. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.LoadBalancerPort"> <summary> The external port of the load balancer to associate the policy. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerRequest.PolicyNames"> <summary> List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerResponse"> <summary> Returns information about the SetLoadBalancerPoliciesOfListenerResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerResponse.SetLoadBalancerPoliciesOfListenerResult"> <summary> Gets and sets the SetLoadBalancerPoliciesOfListenerResult property. The output for the SetLoadBalancerPoliciesOfListener action. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SetLoadBalancerPoliciesOfListenerResult"> <summary> <para> The output for the SetLoadBalancerPoliciesOfListener action. </para> </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup"> <summary> <para> This data type is used as a response element in the DescribeLoadBalancers action. For information about Elastic Load Balancing security groups, go to <a href="http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-security-features.html#using-elb-security-groups" >Using Security Groups With Elastic Load Balancing</a> in the <i>Elastic Load Balancing Developer Guide</i> . </para> </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup.WithOwnerAlias(System.String)"> <summary> Sets the OwnerAlias property </summary> <param name="ownerAlias">The value to set for the OwnerAlias property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup.WithGroupName(System.String)"> <summary> Sets the GroupName property </summary> <param name="groupName">The value to set for the GroupName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup.OwnerAlias"> <summary> Owner of the source security group. Use this value for the <c>--source-group-user</c> parameter of the <c>ec2-authorize</c> command in the Amazon EC2 command line tool. </summary> </member> <member name="P:Amazon.ElasticLoadBalancing.Model.SourceSecurityGroup.GroupName"> <summary> Name of the source security group. Use this value for the <c>--source-group</c> parameter of the <c>ec2-authorize</c> command in the Amazon EC2 command line tool. </summary> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.SubnetNotFoundException.#ctor(System.String)"> <summary> Constructs a new SubnetNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.TooManyLoadBalancersException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.TooManyLoadBalancersException.#ctor(System.String)"> <summary> Constructs a new TooManyLoadBalancersException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException"> <summary> AmazonElasticLoadBalancing exception </summary> </member> <member name="M:Amazon.ElasticLoadBalancing.Model.TooManyPoliciesException.#ctor(System.String)"> <summary> Constructs a new TooManyPoliciesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"> <summary> Implementation for accessing ElasticMapReduce This is the <i>Amazon Elastic MapReduce API Reference</i>. This guide provides descriptions and samples of the Amazon Elastic MapReduce APIs. <para> 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. </para> </summary> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginAddInstanceGroups(Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the AddInstanceGroups operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddInstanceGroups operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndAddInstanceGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddInstanceGroups.</param> <returns>Returns a AddInstanceGroupsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginAddJobFlowSteps(Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddJobFlowSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the AddJobFlowSteps operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddJobFlowSteps operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndAddJobFlowSteps(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddJobFlowSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddJobFlowSteps.</param> <returns>Returns a AddJobFlowStepsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginAddTags(Amazon.ElasticMapReduce.Model.AddTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddTags operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndAddTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTags.</param> <returns>Returns a AddTagsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginDescribeCluster(Amazon.ElasticMapReduce.Model.DescribeClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCluster operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCluster operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCluster operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndDescribeCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCluster operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCluster.</param> <returns>Returns a DescribeClusterResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginDescribeJobFlows(Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeJobFlows operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJobFlows operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndDescribeJobFlows(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeJobFlows.</param> <returns>Returns a DescribeJobFlowsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginDescribeStep(Amazon.ElasticMapReduce.Model.DescribeStepRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStep operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStep operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStep operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndDescribeStep(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStep operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStep.</param> <returns>Returns a DescribeStepResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginListBootstrapActions(Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListBootstrapActions operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListBootstrapActions operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBootstrapActions operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndListBootstrapActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListBootstrapActions operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListBootstrapActions.</param> <returns>Returns a ListBootstrapActionsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginListClusters(Amazon.ElasticMapReduce.Model.ListClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListClusters operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListClusters operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndListClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListClusters operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListClusters.</param> <returns>Returns a ListClustersResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginListInstanceGroups(Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceGroups operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstanceGroups operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndListInstanceGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstanceGroups.</param> <returns>Returns a ListInstanceGroupsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginListInstances(Amazon.ElasticMapReduce.Model.ListInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstances operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstances operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstances operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndListInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstances operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstances.</param> <returns>Returns a ListInstancesResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginListSteps(Amazon.ElasticMapReduce.Model.ListStepsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListSteps operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSteps operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndListSteps(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSteps.</param> <returns>Returns a ListStepsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginModifyInstanceGroups(Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceGroups operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyInstanceGroups operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndModifyInstanceGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyInstanceGroups.</param> <returns>Returns a ModifyInstanceGroupsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginRemoveTags(Amazon.ElasticMapReduce.Model.RemoveTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveTags operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndRemoveTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTags.</param> <returns>Returns a RemoveTagsResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginRunJobFlow(Amazon.ElasticMapReduce.Model.RunJobFlowRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RunJobFlow operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the RunJobFlow operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRunJobFlow operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndRunJobFlow(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RunJobFlow operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRunJobFlow.</param> <returns>Returns a RunJobFlowResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginSetTerminationProtection(Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetTerminationProtection operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the SetTerminationProtection operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetTerminationProtection operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndSetTerminationProtection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetTerminationProtection operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetTerminationProtection.</param> <returns>Returns a SetTerminationProtectionResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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.AmazonElasticMapReduce.BeginSetVisibleToAllUsers(Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetVisibleToAllUsers operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the SetVisibleToAllUsers operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetVisibleToAllUsers operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndSetVisibleToAllUsers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetVisibleToAllUsers operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetVisibleToAllUsers.</param> <returns>Returns a SetVisibleToAllUsersResult from ElasticMapReduce.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.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 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.AmazonElasticMapReduce.BeginTerminateJobFlows(Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the TerminateJobFlows operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateJobFlows operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduce.EndTerminateJobFlows(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateJobFlows.</param> <returns>Returns a TerminateJobFlowsResult from ElasticMapReduce.</returns> </member> <member name="T:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient"> <summary> Implementation for accessing ElasticMapReduce This is the <i>Amazon Elastic MapReduce API Reference</i>. This guide provides descriptions and samples of the Amazon Elastic MapReduce APIs. <para> 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. </para> </summary> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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.BeginAddInstanceGroups(Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the AddInstanceGroups operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddInstanceGroups operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndAddInstanceGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddInstanceGroups.</param> <returns>Returns a AddInstanceGroupsResult from ElasticMapReduce.</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.BeginAddJobFlowSteps(Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddJobFlowSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the AddJobFlowSteps operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddJobFlowSteps operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndAddJobFlowSteps(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddJobFlowSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddJobFlowSteps.</param> <returns>Returns a AddJobFlowStepsResult from ElasticMapReduce.</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.BeginAddTags(Amazon.ElasticMapReduce.Model.AddTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddTags operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndAddTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTags.</param> <returns>Returns a AddTagsResult from ElasticMapReduce.</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.BeginDescribeCluster(Amazon.ElasticMapReduce.Model.DescribeClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCluster operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCluster operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCluster operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndDescribeCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCluster operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCluster.</param> <returns>Returns a DescribeClusterResult from ElasticMapReduce.</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.BeginDescribeJobFlows(Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeJobFlows operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJobFlows operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndDescribeJobFlows(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeJobFlows.</param> <returns>Returns a DescribeJobFlowsResult from ElasticMapReduce.</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.BeginDescribeStep(Amazon.ElasticMapReduce.Model.DescribeStepRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStep operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStep operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStep operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndDescribeStep(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStep operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStep.</param> <returns>Returns a DescribeStepResult from ElasticMapReduce.</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.BeginListBootstrapActions(Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListBootstrapActions operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListBootstrapActions operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBootstrapActions operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndListBootstrapActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListBootstrapActions operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListBootstrapActions.</param> <returns>Returns a ListBootstrapActionsResult from ElasticMapReduce.</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.BeginListClusters(Amazon.ElasticMapReduce.Model.ListClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListClusters operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListClusters operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndListClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListClusters operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListClusters.</param> <returns>Returns a ListClustersResult from ElasticMapReduce.</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.BeginListInstanceGroups(Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceGroups operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstanceGroups operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndListInstanceGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstanceGroups.</param> <returns>Returns a ListInstanceGroupsResult from ElasticMapReduce.</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.BeginListInstances(Amazon.ElasticMapReduce.Model.ListInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstances operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstances operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstances operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndListInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstances operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstances.</param> <returns>Returns a ListInstancesResult from ElasticMapReduce.</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.BeginListSteps(Amazon.ElasticMapReduce.Model.ListStepsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ListSteps operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSteps operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndListSteps(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSteps operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSteps.</param> <returns>Returns a ListStepsResult from ElasticMapReduce.</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.BeginModifyInstanceGroups(Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceGroups operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyInstanceGroups operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndModifyInstanceGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyInstanceGroups operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyInstanceGroups.</param> <returns>Returns a ModifyInstanceGroupsResult from ElasticMapReduce.</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.BeginRemoveTags(Amazon.ElasticMapReduce.Model.RemoveTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveTags operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndRemoveTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTags operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTags.</param> <returns>Returns a RemoveTagsResult from ElasticMapReduce.</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.BeginRunJobFlow(Amazon.ElasticMapReduce.Model.RunJobFlowRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RunJobFlow operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the RunJobFlow operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRunJobFlow operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndRunJobFlow(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RunJobFlow operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRunJobFlow.</param> <returns>Returns a RunJobFlowResult from ElasticMapReduce.</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.BeginSetTerminationProtection(Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetTerminationProtection operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the SetTerminationProtection operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetTerminationProtection operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndSetTerminationProtection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetTerminationProtection operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetTerminationProtection.</param> <returns>Returns a SetTerminationProtectionResult from ElasticMapReduce.</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.BeginSetVisibleToAllUsers(Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetVisibleToAllUsers operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the SetVisibleToAllUsers operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetVisibleToAllUsers operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndSetVisibleToAllUsers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetVisibleToAllUsers operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetVisibleToAllUsers.</param> <returns>Returns a SetVisibleToAllUsersResult from ElasticMapReduce.</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 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.BeginTerminateJobFlows(Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="request">Container for the necessary parameters to execute the TerminateJobFlows operation on AmazonElasticMapReduceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateJobFlows operation.</returns> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceClient.EndTerminateJobFlows(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateJobFlows operation. <seealso cref="T:Amazon.ElasticMapReduce.AmazonElasticMapReduce"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateJobFlows.</param> <returns>Returns a TerminateJobFlowsResult from ElasticMapReduce.</returns> </member> <member name="T:Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig"> <summary> Configuration for accessing Amazon ElasticMapReduce service </summary> </member> <member name="M:Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.ElasticMapReduce.AmazonElasticMapReduceConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest"> <summary> Container for the parameters to the AddInstanceGroups operation. AddInstanceGroups adds an instance group to a running cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest.WithInstanceGroups(Amazon.ElasticMapReduce.Model.InstanceGroupConfig[])"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest.WithInstanceGroups(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.InstanceGroupConfig})"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest.WithJobFlowId(System.String)"> <summary> Sets the JobFlowId property </summary> <param name="jobFlowId">The value to set for the JobFlowId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest.InstanceGroups"> <summary> Gets and sets the property InstanceGroups. <para> Instance Groups to add. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddInstanceGroupsRequest.JobFlowId"> <summary> Gets and sets the property JobFlowId. <para> Job flow in which to add the instance groups. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResponse"> <summary> Returns information about the AddInstanceGroupsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResponse.AddInstanceGroupsResult"> <summary> Gets and sets the AddInstanceGroupsResult property. Represents the output of a AddInstanceGroups operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResult"> <summary> Output from an AddInstanceGroups call. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResult.WithInstanceGroupIds(System.String[])"> <summary> Sets the InstanceGroupIds property </summary> <param name="instanceGroupIds">The values to add to the InstanceGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResult.WithInstanceGroupIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the InstanceGroupIds property </summary> <param name="instanceGroupIds">The values to add to the InstanceGroupIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResult.WithJobFlowId(System.String)"> <summary> Sets the JobFlowId property </summary> <param name="jobFlowId">The value to set for the JobFlowId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResult.InstanceGroupIds"> <summary> Gets and sets the property InstanceGroupIds. <para> Instance group IDs of the newly created instance groups. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddInstanceGroupsResult.JobFlowId"> <summary> Gets and sets the property JobFlowId. <para> The job flow ID in which the instance groups are added. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest"> <summary> Container for the parameters to the AddJobFlowSteps operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest.WithJobFlowId(System.String)"> <summary> Sets the JobFlowId property </summary> <param name="jobFlowId">The value to set for the JobFlowId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest.WithSteps(Amazon.ElasticMapReduce.Model.StepConfig[])"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest.WithSteps(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.StepConfig})"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest.JobFlowId"> <summary> Gets and sets the property JobFlowId. <para> A string that uniquely identifies the job flow. This identifier is returned by <a>RunJobFlow</a> and can also be obtained from <a>ListClusters</a>. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddJobFlowStepsRequest.Steps"> <summary> Gets and sets the property Steps. <para> A list of <a>StepConfig</a> to be executed by the job flow. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddJobFlowStepsResponse"> <summary> Returns information about the AddJobFlowStepsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddJobFlowStepsResponse.AddJobFlowStepsResult"> <summary> Gets and sets the AddJobFlowStepsResult property. Represents the output of a AddJobFlowSteps operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddJobFlowStepsResult"> <summary> The output for the <a>AddJobFlowSteps</a> operation. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddJobFlowStepsResult.WithStepIds(System.String[])"> <summary> Sets the StepIds property </summary> <param name="stepIds">The values to add to the StepIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddJobFlowStepsResult.WithStepIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the StepIds property </summary> <param name="stepIds">The values to add to the StepIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddJobFlowStepsResult.StepIds"> <summary> Gets and sets the property StepIds. <para> The identifiers of the list of steps added to the job flow. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddTagsRequest"> <summary> Container for the parameters to the AddTags operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddTagsRequest.WithResourceId(System.String)"> <summary> Sets the ResourceId property </summary> <param name="resourceId">The value to set for the ResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddTagsRequest.WithTags(Amazon.ElasticMapReduce.Model.Tag[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddTagsRequest.WithTags(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.Tag})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddTagsRequest.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> A list of tags to associate with a cluster and propagate to Amazon EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddTagsResponse"> <summary> Returns information about the AddTagsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.AddTagsResponse.AddTagsResult"> <summary> Gets and sets the AddTagsResult property. Represents the output of a AddTags operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddTagsResult"> <summary> This output indicates the result of adding tags to a resource. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Application"> <summary> An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-mapr.html">Launch a Job Flow on the MapR Distribution for Hadoop</a>. Currently supported values are: <ul> <li>"mapr-m3" - launch the job flow using MapR M3 Edition.</li> <li>"mapr-m5" - launch the job flow using MapR M5 Edition.</li> <li>"mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition, respectively.</li> </ul> </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.Application.WithAdditionalInfo(System.Collections.Generic.KeyValuePair{System.String,System.String}[])"> <summary> Adds the KeyValuePairs to the AdditionalInfo dictionary. </summary> <param name="pairs">The pairs to be added to the AdditionalInfo dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Application.WithArgs(System.String[])"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Application.WithArgs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Application.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Application.WithVersion(System.String)"> <summary> Sets the Version property </summary> <param name="version">The value to set for the Version property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.Application.AdditionalInfo"> <summary> Gets and sets the property AdditionalInfo. <para> This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Application.Args"> <summary> Gets and sets the property Args. <para> Arguments for Amazon EMR to pass to the application. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Application.Name"> <summary> Gets and sets the property Name. <para> The name of the application. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Application.Version"> <summary> Gets and sets the property Version. <para> The version of the application. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.BootstrapActionConfig"> <summary> Configuration of a bootstrap action. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActionConfig.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActionConfig.WithScriptBootstrapAction(Amazon.ElasticMapReduce.Model.ScriptBootstrapActionConfig)"> <summary> Sets the ScriptBootstrapAction property </summary> <param name="scriptBootstrapAction">The value to set for the ScriptBootstrapAction property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.BootstrapActionConfig.Name"> <summary> Gets and sets the property Name. <para> The name of the bootstrap action. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.BootstrapActionConfig.ScriptBootstrapAction"> <summary> Gets and sets the property ScriptBootstrapAction. <para> The script run by the bootstrap action. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.BootstrapActionDetail"> <summary> Reports the configuration of a bootstrap action in a job flow. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActionDetail.WithBootstrapActionConfig(Amazon.ElasticMapReduce.Model.BootstrapActionConfig)"> <summary> Sets the BootstrapActionConfig property </summary> <param name="bootstrapActionConfig">The value to set for the BootstrapActionConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.BootstrapActionDetail.BootstrapActionConfig"> <summary> Gets and sets the property BootstrapActionConfig. <para> A description of the bootstrap action. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.BootstrapActions"> <summary> Class that provides helper methods for constructing predefined bootstrap actions. </summary> <example> <code> AmazonElasticMapReduce emr = AWSClientFactory.CreateAmazonElasticMapReduceClient(accessKey, secretKey); BootstrapActions bootstrapActions = new BootstrapActions(); RunJobFlowRequest request = new RunJobFlowRequest { Name = "Job Flow With Bootstrap Actions", BootstrapActions = new List<BootstrapActionConfig> { bootstrapActions.NewRunIf( "instance.isMaster=true", bootstrapActions.NewConfigureDaemons() .WithHeapSize(Daemon.JobTracker, 2048) .Build()) }, LogUri = "s3://log-bucket/", Instances = new JobFlowInstancesConfig { Ec2KeyName = "keypair", HadoopVersion = "0.20", InstanceCount = 5, KeepJobFlowAliveWhenNoSteps = true, MasterInstanceType = "m1.small", SlaveInstanceType = "m1.small" } }; </code> </example> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActions.#ctor"> <summary> Creates a new default BootstrapActions for us in us-east-1. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActions.#ctor(System.String)"> <summary> Creates a new BootstrapActions. </summary> <param name="bucket">the bucket from which to download the bootstrap actions.</param> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActions.NewRunIf(System.String,Amazon.ElasticMapReduce.Model.BootstrapActionConfig)"> <summary> Create a new run-if bootstrap action which lets you conditionally run bootstrap actions. </summary> <param name="condition">The condition to evaluate, if true the bootstrap action executes.</param> <param name="config">The bootstrap action to execute in case of successful evaluation.</param> <returns>A BootstrapActionConfig to be provided when running a job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActions.NewConfigureHadoop"> <summary> Create a new bootstrap action which lets you configure Hadoop's XML files. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.BootstrapActions.NewConfigureDaemons"> <summary> Create a new bootstrap action which lets you configure Hadoop's daemons. The options are written to the hadoop-user-env.sh file. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Cluster"> <summary> The detailed description of the cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithApplications(Amazon.ElasticMapReduce.Model.Application[])"> <summary> Sets the Applications property </summary> <param name="applications">The values to add to the Applications collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithApplications(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.Application})"> <summary> Sets the Applications property </summary> <param name="applications">The values to add to the Applications collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithAutoTerminate(System.Boolean)"> <summary> Sets the AutoTerminate property </summary> <param name="autoTerminate">The value to set for the AutoTerminate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithEc2InstanceAttributes(Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes)"> <summary> Sets the Ec2InstanceAttributes property </summary> <param name="ec2InstanceAttributes">The value to set for the Ec2InstanceAttributes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithLogUri(System.String)"> <summary> Sets the LogUri property </summary> <param name="logUri">The value to set for the LogUri property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithRequestedAmiVersion(System.String)"> <summary> Sets the RequestedAmiVersion property </summary> <param name="requestedAmiVersion">The value to set for the RequestedAmiVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithRunningAmiVersion(System.String)"> <summary> Sets the RunningAmiVersion property </summary> <param name="runningAmiVersion">The value to set for the RunningAmiVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithServiceRole(System.String)"> <summary> Sets the ServiceRole property </summary> <param name="serviceRole">The value to set for the ServiceRole property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithStatus(Amazon.ElasticMapReduce.Model.ClusterStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithTags(Amazon.ElasticMapReduce.Model.Tag[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithTags(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.Tag})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithTerminationProtected(System.Boolean)"> <summary> Sets the TerminationProtected property </summary> <param name="terminationProtected">The value to set for the TerminationProtected property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Cluster.WithVisibleToAllUsers(System.Boolean)"> <summary> Sets the VisibleToAllUsers property </summary> <param name="visibleToAllUsers">The value to set for the VisibleToAllUsers property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.Applications"> <summary> Gets and sets the property Applications. <para> The applications installed on this cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.AutoTerminate"> <summary> Gets and sets the property AutoTerminate. <para> Specifies whether the cluster should terminate after completing all steps. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.Ec2InstanceAttributes"> <summary> Gets and sets the property Ec2InstanceAttributes. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.Id"> <summary> Gets and sets the property Id. <para> The unique identifier for the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.LogUri"> <summary> Gets and sets the property LogUri. <para> The path to the Amazon S3 location where logs for this cluster are stored. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.Name"> <summary> Gets and sets the property Name. <para> The name of the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.RequestedAmiVersion"> <summary> Gets and sets the property RequestedAmiVersion. <para> The AMI version requested for this cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.RunningAmiVersion"> <summary> Gets and sets the property RunningAmiVersion. <para> The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as "latest". </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.ServiceRole"> <summary> Gets and sets the property ServiceRole. <para> The IAM role that was specified when the job flow was launched. Amazon ElasticMapReduce will assume this role to work with AWS resources on your behalf. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.Status"> <summary> Gets and sets the property Status. <para> The current status details about the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.Tags"> <summary> Gets and sets the property Tags. <para> A list of tags associated with a cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.TerminationProtected"> <summary> Gets and sets the property TerminationProtected. <para> Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Cluster.VisibleToAllUsers"> <summary> Gets and sets the property VisibleToAllUsers. <para> Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to <code>true</code>, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. If this value is <code>false</code>, only the IAM user that created the cluster can view and manage it. This value can be changed using the <a>SetVisibleToAllUsers</a> action. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ClusterStateChangeReason"> <summary> The reason that the cluster changed to its current state. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterStateChangeReason.WithCode(System.String)"> <summary> Sets the Code property </summary> <param name="code">The value to set for the Code property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterStateChangeReason.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterStateChangeReason.Code"> <summary> Gets and sets the property Code. <para> The programmatic code for the state change reason. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterStateChangeReason.Message"> <summary> Gets and sets the property Message. <para> The descriptive message for the state change reason. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ClusterStatus"> <summary> The detailed status of the cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterStatus.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterStatus.WithStateChangeReason(Amazon.ElasticMapReduce.Model.ClusterStateChangeReason)"> <summary> Sets the StateChangeReason property </summary> <param name="stateChangeReason">The value to set for the StateChangeReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterStatus.WithTimeline(Amazon.ElasticMapReduce.Model.ClusterTimeline)"> <summary> Sets the Timeline property </summary> <param name="timeline">The value to set for the Timeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterStatus.State"> <summary> Gets and sets the property State. <para> The current state of the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterStatus.StateChangeReason"> <summary> Gets and sets the property StateChangeReason. <para> The reason for the cluster status change. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterStatus.Timeline"> <summary> Gets and sets the property Timeline. <para> A timeline that represents the status of a cluster over the lifetime of the cluster. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ClusterSummary"> <summary> The summary description of the cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterSummary.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterSummary.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterSummary.WithStatus(Amazon.ElasticMapReduce.Model.ClusterStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterSummary.Id"> <summary> Gets and sets the property Id. <para> The unique identifier for the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterSummary.Name"> <summary> Gets and sets the property Name. <para> The name of the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterSummary.Status"> <summary> Gets and sets the property Status. <para> The details about the current status of the cluster. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ClusterTimeline"> <summary> Represents the timeline of the cluster's lifecycle. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterTimeline.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterTimeline.WithEndDateTime(System.DateTime)"> <summary> Sets the EndDateTime property </summary> <param name="endDateTime">The value to set for the EndDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ClusterTimeline.WithReadyDateTime(System.DateTime)"> <summary> Sets the ReadyDateTime property </summary> <param name="readyDateTime">The value to set for the ReadyDateTime property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterTimeline.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The creation date and time of the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterTimeline.EndDateTime"> <summary> Gets and sets the property EndDateTime. <para> The date and time when the cluster was terminated. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ClusterTimeline.ReadyDateTime"> <summary> Gets and sets the property ReadyDateTime. <para> The date and time when the cluster was ready to execute steps. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Command"> <summary> An entity describing an executable that runs on a cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.Command.WithArgs(System.String[])"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Command.WithArgs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Command.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Command.WithScriptPath(System.String)"> <summary> Sets the ScriptPath property </summary> <param name="scriptPath">The value to set for the ScriptPath property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.Command.Args"> <summary> Gets and sets the property Args. <para> Arguments for Amazon EMR to pass to the command for execution. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Command.Name"> <summary> Gets and sets the property Name. <para> The name of the command. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Command.ScriptPath"> <summary> Gets and sets the property ScriptPath. <para> The Amazon S3 location of the command script. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Daemon"> <summary> List of Hadoop daemons which can be configured. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ConfigureDaemons.WithHeapSize(Amazon.ElasticMapReduce.Model.Daemon,System.Int32)"> <summary> Set the heap size of a daemon. </summary> <param name="daemon">The deamon to configure.</param> <param name="megabytes">The requested heap size of the daemon.</param> <returns> A reference to this updated object so that method calls can be chained together. </returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ConfigureDaemons.WithOpts(Amazon.ElasticMapReduce.Model.Daemon,System.String)"> <summary> Specify additional Java opts to be included when the daemon starts. </summary> <param name="daemon">The daemon to add opts to.</param> <param name="opts">Additional Java command line arguments.</param> <returns> A reference to this updated object so that method calls can be chained together. </returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ConfigureDaemons.WithReplace(System.Boolean)"> <summary> Replace the existing hadoop-user-env.sh file if it exists. </summary> <param name="replace">whether the file should be replaced.</param> <returns> A reference to this updated object so that method calls can be chained together. </returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ConfigureDaemons.Build"> <summary> Returns an object which can be used in a RunJobflow call. </summary> <returns>an object which can be used in a RunJobflow call.</returns> </member> <member name="T:Amazon.ElasticMapReduce.Model.ConfigFile"> <summary> Valid config files. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ConfigureHadoop.WithXml(Amazon.ElasticMapReduce.Model.ConfigFile,System.String)"> <summary> Specify an XML file in S3 to merge with Hadoop's default configuration. </summary> <param name="file">The config file to merge with.</param> <param name="xmlPath">The path in S3 of the XML file.</param> <returns> A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ConfigureHadoop.WithKeyValue(Amazon.ElasticMapReduce.Model.ConfigFile,System.String,System.String)"> <summary> Specify a key-value pair to merge with Hadoop's default configuration. </summary> <param name="file">The config file to merge with.</param> <param name="key">The config key.</param> <param name="value">The config value.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ConfigureHadoop.Build"> <summary> Returns an object which can be used in a RunJobflow call. </summary> <returns>an object which can be used in a RunJobflow call.</returns> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeClusterRequest"> <summary> Container for the parameters to the DescribeCluster operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeClusterRequest.WithClusterId(System.String)"> <summary> Sets the ClusterId property </summary> <param name="clusterId">The value to set for the ClusterId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeClusterRequest.ClusterId"> <summary> Gets and sets the property ClusterId. <para> The identifier of the cluster to describe. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeClusterResponse"> <summary> Returns information about the DescribeClusterResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeClusterResponse.DescribeClusterResult"> <summary> Gets and sets the DescribeClusterResult property. Represents the output of a DescribeCluster operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeClusterResult"> <summary> This output contains the description of the cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeClusterResult.WithCluster(Amazon.ElasticMapReduce.Model.Cluster)"> <summary> Sets the Cluster property </summary> <param name="cluster">The value to set for the Cluster property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeClusterResult.Cluster"> <summary> Gets and sets the property Cluster. <para> This output contains the details for the requested cluster. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest"> <summary> Container for the parameters to the DescribeJobFlows operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.WithCreatedAfter(System.DateTime)"> <summary> Sets the CreatedAfter property </summary> <param name="createdAfter">The value to set for the CreatedAfter property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.WithCreatedBefore(System.DateTime)"> <summary> Sets the CreatedBefore property </summary> <param name="createdBefore">The value to set for the CreatedBefore property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.WithJobFlowIds(System.String[])"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.WithJobFlowIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.WithJobFlowStates(System.String[])"> <summary> Sets the JobFlowStates property </summary> <param name="jobFlowStates">The values to add to the JobFlowStates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.WithJobFlowStates(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the JobFlowStates property </summary> <param name="jobFlowStates">The values to add to the JobFlowStates collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.CreatedAfter"> <summary> Gets and sets the property CreatedAfter. <para> Return only job flows created after this date and time. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.CreatedBefore"> <summary> Gets and sets the property CreatedBefore. <para> Return only job flows created before this date and time. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.JobFlowIds"> <summary> Gets and sets the property JobFlowIds. <para> Return only job flows whose job flow ID is contained in this list. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeJobFlowsRequest.JobFlowStates"> <summary> Gets and sets the property JobFlowStates. <para> Return only job flows whose state is contained in this list. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeJobFlowsResponse"> <summary> Returns information about the DescribeJobFlowsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeJobFlowsResponse.DescribeJobFlowsResult"> <summary> Gets and sets the DescribeJobFlowsResult property. Represents the output of a DescribeJobFlows operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeJobFlowsResult"> <summary> The output for the <a>DescribeJobFlows</a> operation. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsResult.WithJobFlows(Amazon.ElasticMapReduce.Model.JobFlowDetail[])"> <summary> Sets the JobFlows property </summary> <param name="jobFlows">The values to add to the JobFlows collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeJobFlowsResult.WithJobFlows(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.JobFlowDetail})"> <summary> Sets the JobFlows property </summary> <param name="jobFlows">The values to add to the JobFlows collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeJobFlowsResult.JobFlows"> <summary> Gets and sets the property JobFlows. <para> A list of job flows matching the parameters supplied. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeStepRequest"> <summary> Container for the parameters to the DescribeStep operation. Provides more detail about the cluster step. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeStepRequest.WithClusterId(System.String)"> <summary> Sets the ClusterId property </summary> <param name="clusterId">The value to set for the ClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeStepRequest.WithStepId(System.String)"> <summary> Sets the StepId property </summary> <param name="stepId">The value to set for the StepId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeStepRequest.ClusterId"> <summary> Gets and sets the property ClusterId. <para> The identifier of the cluster with steps to describe. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeStepRequest.StepId"> <summary> Gets and sets the property StepId. <para> The identifier of the step to describe. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeStepResponse"> <summary> Returns information about the DescribeStepResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeStepResponse.DescribeStepResult"> <summary> Gets and sets the DescribeStepResult property. Represents the output of a DescribeStep operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.DescribeStepResult"> <summary> This output contains the description of the cluster step. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.DescribeStepResult.WithStep(Amazon.ElasticMapReduce.Model.Step)"> <summary> Sets the Step property </summary> <param name="step">The value to set for the Step property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.DescribeStepResult.Step"> <summary> Gets and sets the property Step. <para> The step details for the requested step identifier. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes"> <summary> Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.WithEc2AvailabilityZone(System.String)"> <summary> Sets the Ec2AvailabilityZone property </summary> <param name="ec2AvailabilityZone">The value to set for the Ec2AvailabilityZone property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.WithEc2KeyName(System.String)"> <summary> Sets the Ec2KeyName property </summary> <param name="ec2KeyName">The value to set for the Ec2KeyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.WithEc2SubnetId(System.String)"> <summary> Sets the Ec2SubnetId property </summary> <param name="ec2SubnetId">The value to set for the Ec2SubnetId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.WithIamInstanceProfile(System.String)"> <summary> Sets the IamInstanceProfile property </summary> <param name="iamInstanceProfile">The value to set for the IamInstanceProfile property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.Ec2AvailabilityZone"> <summary> Gets and sets the property Ec2AvailabilityZone. <para> The Availability Zone in which the cluster will run. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.Ec2KeyName"> <summary> Gets and sets the property Ec2KeyName. <para> The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop". </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.Ec2SubnetId"> <summary> Gets and sets the property Ec2SubnetId. <para> To launch the job flow in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal AWS cloud, outside of a VPC. </para> <para> Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Ec2InstanceAttributes.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig"> <summary> A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.WithArgs(System.String[])"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.WithArgs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.WithJar(System.String)"> <summary> Sets the Jar property </summary> <param name="jar">The value to set for the Jar property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.WithMainClass(System.String)"> <summary> Sets the MainClass property </summary> <param name="mainClass">The value to set for the MainClass property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.WithProperties(Amazon.ElasticMapReduce.Model.KeyValue[])"> <summary> Sets the Properties property </summary> <param name="properties">The values to add to the Properties collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.WithProperties(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.KeyValue})"> <summary> Sets the Properties property </summary> <param name="properties">The values to add to the Properties collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.Args"> <summary> Gets and sets the property Args. <para> A list of command line arguments passed to the JAR file's main function when executed. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.Jar"> <summary> Gets and sets the property Jar. <para> A path to a JAR file run during the step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.MainClass"> <summary> Gets and sets the property MainClass. <para> The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopJarStepConfig.Properties"> <summary> Gets and sets the property Properties. <para> A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.HadoopStepConfig"> <summary> A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopStepConfig.WithArgs(System.String[])"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopStepConfig.WithArgs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopStepConfig.WithJar(System.String)"> <summary> Sets the Jar property </summary> <param name="jar">The value to set for the Jar property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopStepConfig.WithMainClass(System.String)"> <summary> Sets the MainClass property </summary> <param name="mainClass">The value to set for the MainClass property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.HadoopStepConfig.WithProperties(System.Collections.Generic.KeyValuePair{System.String,System.String}[])"> <summary> Adds the KeyValuePairs to the Properties dictionary. </summary> <param name="pairs">The pairs to be added to the Properties dictionary.</param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopStepConfig.Args"> <summary> Gets and sets the property Args. <para> The list of command line arguments to pass to the JAR file's main function for execution. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopStepConfig.Jar"> <summary> Gets and sets the property Jar. <para> The path to the JAR file that runs during the step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopStepConfig.MainClass"> <summary> Gets and sets the property MainClass. <para> The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.HadoopStepConfig.Properties"> <summary> Gets and sets the property Properties. <para> The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Instance"> <summary> Represents an EC2 instance provisioned as part of cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.Instance.WithEc2InstanceId(System.String)"> <summary> Sets the Ec2InstanceId property </summary> <param name="ec2InstanceId">The value to set for the Ec2InstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Instance.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Instance.WithPrivateDnsName(System.String)"> <summary> Sets the PrivateDnsName property </summary> <param name="privateDnsName">The value to set for the PrivateDnsName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Instance.WithPrivateIpAddress(System.String)"> <summary> Sets the PrivateIpAddress property </summary> <param name="privateIpAddress">The value to set for the PrivateIpAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Instance.WithPublicDnsName(System.String)"> <summary> Sets the PublicDnsName property </summary> <param name="publicDnsName">The value to set for the PublicDnsName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Instance.WithPublicIpAddress(System.String)"> <summary> Sets the PublicIpAddress property </summary> <param name="publicIpAddress">The value to set for the PublicIpAddress property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Instance.WithStatus(Amazon.ElasticMapReduce.Model.InstanceStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.Instance.Ec2InstanceId"> <summary> Gets and sets the property Ec2InstanceId. <para> The unique identifier of the instance in Amazon EC2. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Instance.Id"> <summary> Gets and sets the property Id. <para> The unique identifier for the instance in Amazon EMR. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Instance.PrivateDnsName"> <summary> Gets and sets the property PrivateDnsName. <para> The private DNS name of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Instance.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The private IP address of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Instance.PublicDnsName"> <summary> Gets and sets the property PublicDnsName. <para> The public DNS name of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Instance.PublicIpAddress"> <summary> Gets and sets the property PublicIpAddress. <para> The public IP address of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Instance.Status"> <summary> Gets and sets the property Status. <para> The current status of the instance. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceGroup"> <summary> This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithBidPrice(System.String)"> <summary> Sets the BidPrice property </summary> <param name="bidPrice">The value to set for the BidPrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithInstanceGroupType(System.String)"> <summary> Sets the InstanceGroupType property </summary> <param name="instanceGroupType">The value to set for the InstanceGroupType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithInstanceType(System.String)"> <summary> Sets the InstanceType property </summary> <param name="instanceType">The value to set for the InstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithMarket(System.String)"> <summary> Sets the Market property </summary> <param name="market">The value to set for the Market property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithRequestedInstanceCount(System.Int32)"> <summary> Sets the RequestedInstanceCount property </summary> <param name="requestedInstanceCount">The value to set for the RequestedInstanceCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithRunningInstanceCount(System.Int32)"> <summary> Sets the RunningInstanceCount property </summary> <param name="runningInstanceCount">The value to set for the RunningInstanceCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroup.WithStatus(Amazon.ElasticMapReduce.Model.InstanceGroupStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.BidPrice"> <summary> Gets and sets the property BidPrice. <para> The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.Id"> <summary> Gets and sets the property Id. <para> The identifier of the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.InstanceGroupType"> <summary> Gets and sets the property InstanceGroupType. <para> The type of the instance group. Valid values are MASTER, CORE or TASK. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The EC2 instance type for all instances in the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.Market"> <summary> Gets and sets the property Market. <para> The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.Name"> <summary> Gets and sets the property Name. <para> The name of the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.RequestedInstanceCount"> <summary> Gets and sets the property RequestedInstanceCount. <para> The target number of instances for the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.RunningInstanceCount"> <summary> Gets and sets the property RunningInstanceCount. <para> The number of instances currently running in this instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroup.Status"> <summary> Gets and sets the property Status. <para> The current status of the instance group. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceGroupConfig"> <summary> Configuration defining a new instance group. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.WithBidPrice(System.String)"> <summary> Sets the BidPrice property </summary> <param name="bidPrice">The value to set for the BidPrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.WithInstanceCount(System.Int32)"> <summary> Sets the InstanceCount property </summary> <param name="instanceCount">The value to set for the InstanceCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.WithInstanceRole(System.String)"> <summary> Sets the InstanceRole property </summary> <param name="instanceRole">The value to set for the InstanceRole property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.WithInstanceType(System.String)"> <summary> Sets the InstanceType property </summary> <param name="instanceType">The value to set for the InstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.WithMarket(System.String)"> <summary> Sets the Market property </summary> <param name="market">The value to set for the Market property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.BidPrice"> <summary> Gets and sets the property BidPrice. <para> Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> Target number of instances for the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.InstanceRole"> <summary> Gets and sets the property InstanceRole. <para> The role of the instance group in the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The Amazon EC2 instance type for all instances in the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.Market"> <summary> Gets and sets the property Market. <para> Market type of the Amazon EC2 instances used to create a cluster node. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupConfig.Name"> <summary> Gets and sets the property Name. <para> Friendly name given to the instance group. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceGroupDetail"> <summary> Detailed information about an instance group. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithBidPrice(System.String)"> <summary> Sets the BidPrice property </summary> <param name="bidPrice">The value to set for the BidPrice property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithEndDateTime(System.DateTime)"> <summary> Sets the EndDateTime property </summary> <param name="endDateTime">The value to set for the EndDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithInstanceGroupId(System.String)"> <summary> Sets the InstanceGroupId property </summary> <param name="instanceGroupId">The value to set for the InstanceGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithInstanceRequestCount(System.Int32)"> <summary> Sets the InstanceRequestCount property </summary> <param name="instanceRequestCount">The value to set for the InstanceRequestCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithInstanceRole(System.String)"> <summary> Sets the InstanceRole property </summary> <param name="instanceRole">The value to set for the InstanceRole property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithInstanceRunningCount(System.Int32)"> <summary> Sets the InstanceRunningCount property </summary> <param name="instanceRunningCount">The value to set for the InstanceRunningCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithInstanceType(System.String)"> <summary> Sets the InstanceType property </summary> <param name="instanceType">The value to set for the InstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithLastStateChangeReason(System.String)"> <summary> Sets the LastStateChangeReason property </summary> <param name="lastStateChangeReason">The value to set for the LastStateChangeReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithMarket(System.String)"> <summary> Sets the Market property </summary> <param name="market">The value to set for the Market property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithReadyDateTime(System.DateTime)"> <summary> Sets the ReadyDateTime property </summary> <param name="readyDateTime">The value to set for the ReadyDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithStartDateTime(System.DateTime)"> <summary> Sets the StartDateTime property </summary> <param name="startDateTime">The value to set for the StartDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.BidPrice"> <summary> Gets and sets the property BidPrice. <para> Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The date/time the instance group was created. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.EndDateTime"> <summary> Gets and sets the property EndDateTime. <para> The date/time the instance group was terminated. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.InstanceGroupId"> <summary> Gets and sets the property InstanceGroupId. <para> Unique identifier for the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.InstanceRequestCount"> <summary> Gets and sets the property InstanceRequestCount. <para> Target number of instances to run in the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.InstanceRole"> <summary> Gets and sets the property InstanceRole. <para> Instance group role in the cluster </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.InstanceRunningCount"> <summary> Gets and sets the property InstanceRunningCount. <para> Actual count of running instances. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.InstanceType"> <summary> Gets and sets the property InstanceType. <para> Amazon EC2 Instance type. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.LastStateChangeReason"> <summary> Gets and sets the property LastStateChangeReason. <para> Details regarding the state of the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.Market"> <summary> Gets and sets the property Market. <para> Market type of the Amazon EC2 instances used to create a cluster node. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.Name"> <summary> Gets and sets the property Name. <para> Friendly name for the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.ReadyDateTime"> <summary> Gets and sets the property ReadyDateTime. <para> The date/time the instance group was available to the cluster. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.StartDateTime"> <summary> Gets and sets the property StartDateTime. <para> The date/time the instance group was started. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupDetail.State"> <summary> Gets and sets the property State. <para> State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig"> <summary> Modify an instance group size. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig.WithEC2InstanceIdsToTerminate(System.String[])"> <summary> Sets the EC2InstanceIdsToTerminate property </summary> <param name="eC2InstanceIdsToTerminate">The values to add to the EC2InstanceIdsToTerminate collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig.WithEC2InstanceIdsToTerminate(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the EC2InstanceIdsToTerminate property </summary> <param name="eC2InstanceIdsToTerminate">The values to add to the EC2InstanceIdsToTerminate collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig.WithInstanceCount(System.Int32)"> <summary> Sets the InstanceCount property </summary> <param name="instanceCount">The value to set for the InstanceCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig.WithInstanceGroupId(System.String)"> <summary> Sets the InstanceGroupId property </summary> <param name="instanceGroupId">The value to set for the InstanceGroupId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig.EC2InstanceIdsToTerminate"> <summary> Gets and sets the property EC2InstanceIdsToTerminate. <para> The EC2 InstanceIds to terminate. For advanced users only. Once you terminate the instances, the instance group will not return to its original requested size. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> Target size for the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig.InstanceGroupId"> <summary> Gets and sets the property InstanceGroupId. <para> Unique ID of the instance group to expand or shrink. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceGroupStateChangeReason"> <summary> The status change reason details for the instance group. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupStateChangeReason.WithCode(System.String)"> <summary> Sets the Code property </summary> <param name="code">The value to set for the Code property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupStateChangeReason.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupStateChangeReason.Code"> <summary> Gets and sets the property Code. <para> The programmable code for the state change reason. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupStateChangeReason.Message"> <summary> Gets and sets the property Message. <para> The status change reason description. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceGroupStatus"> <summary> The details of the instance group status. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupStatus.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupStatus.WithStateChangeReason(Amazon.ElasticMapReduce.Model.InstanceGroupStateChangeReason)"> <summary> Sets the StateChangeReason property </summary> <param name="stateChangeReason">The value to set for the StateChangeReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupStatus.WithTimeline(Amazon.ElasticMapReduce.Model.InstanceGroupTimeline)"> <summary> Sets the Timeline property </summary> <param name="timeline">The value to set for the Timeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupStatus.State"> <summary> Gets and sets the property State. <para> The current state of the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupStatus.StateChangeReason"> <summary> Gets and sets the property StateChangeReason. <para> The status change reason details for the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupStatus.Timeline"> <summary> Gets and sets the property Timeline. <para> The timeline of the instance group status over time. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceGroupTimeline"> <summary> The timeline of the instance group lifecycle. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupTimeline.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupTimeline.WithEndDateTime(System.DateTime)"> <summary> Sets the EndDateTime property </summary> <param name="endDateTime">The value to set for the EndDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceGroupTimeline.WithReadyDateTime(System.DateTime)"> <summary> Sets the ReadyDateTime property </summary> <param name="readyDateTime">The value to set for the ReadyDateTime property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupTimeline.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The creation date and time of the instance group. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupTimeline.EndDateTime"> <summary> Gets and sets the property EndDateTime. <para> The date and time when the instance group terminated. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceGroupTimeline.ReadyDateTime"> <summary> Gets and sets the property ReadyDateTime. <para> The date and time when the instance group became ready to perform tasks. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceStateChangeReason"> <summary> The details of the status change reason for the instance. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceStateChangeReason.WithCode(System.String)"> <summary> Sets the Code property </summary> <param name="code">The value to set for the Code property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceStateChangeReason.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceStateChangeReason.Code"> <summary> Gets and sets the property Code. <para> The programmable code for the state change reason. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceStateChangeReason.Message"> <summary> Gets and sets the property Message. <para> The status change reason description. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceStatus"> <summary> The instance status details. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceStatus.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceStatus.WithStateChangeReason(Amazon.ElasticMapReduce.Model.InstanceStateChangeReason)"> <summary> Sets the StateChangeReason property </summary> <param name="stateChangeReason">The value to set for the StateChangeReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceStatus.WithTimeline(Amazon.ElasticMapReduce.Model.InstanceTimeline)"> <summary> Sets the Timeline property </summary> <param name="timeline">The value to set for the Timeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceStatus.State"> <summary> Gets and sets the property State. <para> The current state of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceStatus.StateChangeReason"> <summary> Gets and sets the property StateChangeReason. <para> The details of the status change reason for the instance. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceStatus.Timeline"> <summary> Gets and sets the property Timeline. <para> The timeline of the instance status over time. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InstanceTimeline"> <summary> The timeline of the instance lifecycle. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceTimeline.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceTimeline.WithEndDateTime(System.DateTime)"> <summary> Sets the EndDateTime property </summary> <param name="endDateTime">The value to set for the EndDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.InstanceTimeline.WithReadyDateTime(System.DateTime)"> <summary> Sets the ReadyDateTime property </summary> <param name="readyDateTime">The value to set for the ReadyDateTime property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceTimeline.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The creation date and time of the instance. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceTimeline.EndDateTime"> <summary> Gets and sets the property EndDateTime. <para> The date and time when the instance was terminated. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.InstanceTimeline.ReadyDateTime"> <summary> Gets and sets the property ReadyDateTime. <para> The date and time when the instance was ready to perform tasks. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.InternalServerErrorException"> <summary> ElasticMapReduce exception </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InternalServerErrorException.#ctor(System.String)"> <summary> Constructs a new InternalServerErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticMapReduce.Model.InternalServerException"> <summary> ElasticMapReduce exception </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InternalServerException.#ctor(System.String)"> <summary> Constructs a new InternalServerException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticMapReduce.Model.InvalidRequestException"> <summary> ElasticMapReduce exception </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.InvalidRequestException.#ctor(System.String)"> <summary> Constructs a new InvalidRequestException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticMapReduce.Model.JobFlowDetail"> <summary> A description of a job flow. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithAmiVersion(System.String)"> <summary> Sets the AmiVersion property </summary> <param name="amiVersion">The value to set for the AmiVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithBootstrapActions(Amazon.ElasticMapReduce.Model.BootstrapActionDetail[])"> <summary> Sets the BootstrapActions property </summary> <param name="bootstrapActions">The values to add to the BootstrapActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithBootstrapActions(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.BootstrapActionDetail})"> <summary> Sets the BootstrapActions property </summary> <param name="bootstrapActions">The values to add to the BootstrapActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithExecutionStatusDetail(Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail)"> <summary> Sets the ExecutionStatusDetail property </summary> <param name="executionStatusDetail">The value to set for the ExecutionStatusDetail property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithInstances(Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail)"> <summary> Sets the Instances property </summary> <param name="instances">The value to set for the Instances property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithJobFlowId(System.String)"> <summary> Sets the JobFlowId property </summary> <param name="jobFlowId">The value to set for the JobFlowId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithJobFlowRole(System.String)"> <summary> Sets the JobFlowRole property </summary> <param name="jobFlowRole">The value to set for the JobFlowRole property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithLogUri(System.String)"> <summary> Sets the LogUri property </summary> <param name="logUri">The value to set for the LogUri property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithServiceRole(System.String)"> <summary> Sets the ServiceRole property </summary> <param name="serviceRole">The value to set for the ServiceRole property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithSteps(Amazon.ElasticMapReduce.Model.StepDetail[])"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithSteps(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.StepDetail})"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithSupportedProducts(System.String[])"> <summary> Sets the SupportedProducts property </summary> <param name="supportedProducts">The values to add to the SupportedProducts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithSupportedProducts(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the SupportedProducts property </summary> <param name="supportedProducts">The values to add to the SupportedProducts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowDetail.WithVisibleToAllUsers(System.Boolean)"> <summary> Sets the VisibleToAllUsers property </summary> <param name="visibleToAllUsers">The value to set for the VisibleToAllUsers property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.AmiVersion"> <summary> Gets and sets the property AmiVersion. <para> The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon ElasticMapReduce, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/EnvironmentConfig_AMIVersion.html#ami-versions-supported">AMI Versions Supported in Elastic MapReduce</a> in the <i>Amazon Elastic MapReduce Developer's Guide.</i> </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.BootstrapActions"> <summary> Gets and sets the property BootstrapActions. <para> A list of the bootstrap actions run by the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.ExecutionStatusDetail"> <summary> Gets and sets the property ExecutionStatusDetail. <para> Describes the execution status of the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.Instances"> <summary> Gets and sets the property Instances. <para> Describes the Amazon EC2 instances of the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.JobFlowId"> <summary> Gets and sets the property JobFlowId. <para> The job flow identifier. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.JobFlowRole"> <summary> Gets and sets the property JobFlowRole. <para> The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.LogUri"> <summary> Gets and sets the property LogUri. <para> The location in Amazon S3 where log files for the job are stored. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.Name"> <summary> Gets and sets the property Name. <para> The name of the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.ServiceRole"> <summary> Gets and sets the property ServiceRole. <para> The IAM role that was specified when the job flow was launched. Amazon ElasticMapReduce will assume this role to work with AWS resources on your behalf. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.Steps"> <summary> Gets and sets the property Steps. <para> A list of steps run by the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.SupportedProducts"> <summary> Gets and sets the property SupportedProducts. <para> A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowDetail.VisibleToAllUsers"> <summary> Gets and sets the property VisibleToAllUsers. <para> Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to <code>true</code>, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to <code>false</code>, only the IAM user that created the job flow can view and manage it. This value can be changed using the <a>SetVisibleToAllUsers</a> action. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail"> <summary> Describes the status of the job flow. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.WithEndDateTime(System.DateTime)"> <summary> Sets the EndDateTime property </summary> <param name="endDateTime">The value to set for the EndDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.WithLastStateChangeReason(System.String)"> <summary> Sets the LastStateChangeReason property </summary> <param name="lastStateChangeReason">The value to set for the LastStateChangeReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.WithReadyDateTime(System.DateTime)"> <summary> Sets the ReadyDateTime property </summary> <param name="readyDateTime">The value to set for the ReadyDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.WithStartDateTime(System.DateTime)"> <summary> Sets the StartDateTime property </summary> <param name="startDateTime">The value to set for the StartDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The creation date and time of the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.EndDateTime"> <summary> Gets and sets the property EndDateTime. <para> The completion date and time of the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.LastStateChangeReason"> <summary> Gets and sets the property LastStateChangeReason. <para> Description of the job flow last changed state. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.ReadyDateTime"> <summary> Gets and sets the property ReadyDateTime. <para> The date and time when the job flow was ready to start running bootstrap actions. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.StartDateTime"> <summary> Gets and sets the property StartDateTime. <para> The start date and time of the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowExecutionStatusDetail.State"> <summary> Gets and sets the property State. <para> The state of the job flow. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig"> <summary> A description of the Amazon EC2 instance running the job flow. A valid JobFlowInstancesConfig must contain at least InstanceGroups, which is the recommended configuration. However, a valid alternative is to have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present). </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithEc2KeyName(System.String)"> <summary> Sets the Ec2KeyName property </summary> <param name="ec2KeyName">The value to set for the Ec2KeyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithEc2SubnetId(System.String)"> <summary> Sets the Ec2SubnetId property </summary> <param name="ec2SubnetId">The value to set for the Ec2SubnetId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithHadoopVersion(System.String)"> <summary> Sets the HadoopVersion property </summary> <param name="hadoopVersion">The value to set for the HadoopVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithInstanceCount(System.Int32)"> <summary> Sets the InstanceCount property </summary> <param name="instanceCount">The value to set for the InstanceCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithInstanceGroups(Amazon.ElasticMapReduce.Model.InstanceGroupConfig[])"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithInstanceGroups(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.InstanceGroupConfig})"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithKeepJobFlowAliveWhenNoSteps(System.Boolean)"> <summary> Sets the KeepJobFlowAliveWhenNoSteps property </summary> <param name="keepJobFlowAliveWhenNoSteps">The value to set for the KeepJobFlowAliveWhenNoSteps property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithMasterInstanceType(System.String)"> <summary> Sets the MasterInstanceType property </summary> <param name="masterInstanceType">The value to set for the MasterInstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithPlacement(Amazon.ElasticMapReduce.Model.PlacementType)"> <summary> Sets the Placement property </summary> <param name="placement">The value to set for the Placement property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithSlaveInstanceType(System.String)"> <summary> Sets the SlaveInstanceType property </summary> <param name="slaveInstanceType">The value to set for the SlaveInstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.WithTerminationProtected(System.Boolean)"> <summary> Sets the TerminationProtected property </summary> <param name="terminationProtected">The value to set for the TerminationProtected property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.Ec2KeyName"> <summary> Gets and sets the property Ec2KeyName. <para> The name of the Amazon EC2 key pair that can be used to ssh to the master node as the user called "hadoop." </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.Ec2SubnetId"> <summary> Gets and sets the property Ec2SubnetId. <para> To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an Amazon VPC. </para> <para> Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.HadoopVersion"> <summary> Gets and sets the property HadoopVersion. <para> The Hadoop version for the job flow. Valid inputs are "0.18", "0.20", or "0.20.205". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> The number of Amazon EC2 instances used to execute the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.InstanceGroups"> <summary> Gets and sets the property InstanceGroups. <para> Configuration for the job flow's instance groups. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.KeepJobFlowAliveWhenNoSteps"> <summary> Gets and sets the property KeepJobFlowAliveWhenNoSteps. <para> Specifies whether the job flow should terminate after completing all steps. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.MasterInstanceType"> <summary> Gets and sets the property MasterInstanceType. <para> The EC2 instance type of the master node. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.Placement"> <summary> Gets and sets the property Placement. <para> The Availability Zone the job flow will run in. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.SlaveInstanceType"> <summary> Gets and sets the property SlaveInstanceType. <para> The EC2 instance type of the slave nodes. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig.TerminationProtected"> <summary> Gets and sets the property TerminationProtected. <para> Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail"> <summary> Specify the type of Amazon EC2 instances to run the job flow on. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithEc2KeyName(System.String)"> <summary> Sets the Ec2KeyName property </summary> <param name="ec2KeyName">The value to set for the Ec2KeyName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithEc2SubnetId(System.String)"> <summary> Sets the Ec2SubnetId property </summary> <param name="ec2SubnetId">The value to set for the Ec2SubnetId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithHadoopVersion(System.String)"> <summary> Sets the HadoopVersion property </summary> <param name="hadoopVersion">The value to set for the HadoopVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithInstanceCount(System.Int32)"> <summary> Sets the InstanceCount property </summary> <param name="instanceCount">The value to set for the InstanceCount property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithInstanceGroups(Amazon.ElasticMapReduce.Model.InstanceGroupDetail[])"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithInstanceGroups(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.InstanceGroupDetail})"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithKeepJobFlowAliveWhenNoSteps(System.Boolean)"> <summary> Sets the KeepJobFlowAliveWhenNoSteps property </summary> <param name="keepJobFlowAliveWhenNoSteps">The value to set for the KeepJobFlowAliveWhenNoSteps property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithMasterInstanceId(System.String)"> <summary> Sets the MasterInstanceId property </summary> <param name="masterInstanceId">The value to set for the MasterInstanceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithMasterInstanceType(System.String)"> <summary> Sets the MasterInstanceType property </summary> <param name="masterInstanceType">The value to set for the MasterInstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithMasterPublicDnsName(System.String)"> <summary> Sets the MasterPublicDnsName property </summary> <param name="masterPublicDnsName">The value to set for the MasterPublicDnsName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithNormalizedInstanceHours(System.Int32)"> <summary> Sets the NormalizedInstanceHours property </summary> <param name="normalizedInstanceHours">The value to set for the NormalizedInstanceHours property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithPlacement(Amazon.ElasticMapReduce.Model.PlacementType)"> <summary> Sets the Placement property </summary> <param name="placement">The value to set for the Placement property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithSlaveInstanceType(System.String)"> <summary> Sets the SlaveInstanceType property </summary> <param name="slaveInstanceType">The value to set for the SlaveInstanceType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.WithTerminationProtected(System.Boolean)"> <summary> Sets the TerminationProtected property </summary> <param name="terminationProtected">The value to set for the TerminationProtected property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.Ec2KeyName"> <summary> Gets and sets the property Ec2KeyName. <para> The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.Ec2SubnetId"> <summary> Gets and sets the property Ec2SubnetId. <para> For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.HadoopVersion"> <summary> Gets and sets the property HadoopVersion. <para> The Hadoop version for the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.InstanceGroups"> <summary> Gets and sets the property InstanceGroups. <para> Details about the job flow's instance groups. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.KeepJobFlowAliveWhenNoSteps"> <summary> Gets and sets the property KeepJobFlowAliveWhenNoSteps. <para> Specifies whether the job flow should terminate after completing all steps. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.MasterInstanceId"> <summary> Gets and sets the property MasterInstanceId. <para> The Amazon EC2 instance identifier of the master node. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.MasterInstanceType"> <summary> Gets and sets the property MasterInstanceType. <para> The Amazon EC2 master node instance type. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.MasterPublicDnsName"> <summary> Gets and sets the property MasterPublicDnsName. <para> The DNS name of the master node. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.NormalizedInstanceHours"> <summary> Gets and sets the property NormalizedInstanceHours. <para> An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented once for every hour an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.Placement"> <summary> Gets and sets the property Placement. <para> The Amazon EC2 Availability Zone for the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.SlaveInstanceType"> <summary> Gets and sets the property SlaveInstanceType. <para> The Amazon EC2 slave node instance type. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.JobFlowInstancesDetail.TerminationProtected"> <summary> Gets and sets the property TerminationProtected. <para> Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.KeyValue"> <summary> A key value pair. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.KeyValue.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.KeyValue.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.KeyValue.Key"> <summary> Gets and sets the property Key. <para> The unique identifier of a key value pair. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.KeyValue.Value"> <summary> Gets and sets the property Value. <para> The value part of the identified key. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest"> <summary> Container for the parameters to the ListBootstrapActions operation. Provides information about the bootstrap actions associated with a cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest.WithClusterId(System.String)"> <summary> Sets the ClusterId property </summary> <param name="clusterId">The value to set for the ClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest.ClusterId"> <summary> Gets and sets the property ClusterId. <para> The cluster identifier for the bootstrap actions to list . </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListBootstrapActionsRequest.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve . </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResponse"> <summary> Returns information about the ListBootstrapActionsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResponse.ListBootstrapActionsResult"> <summary> Gets and sets the ListBootstrapActionsResult property. Represents the output of a ListBootstrapActions operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResult"> <summary> This output contains the boostrap actions detail . </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResult.WithBootstrapActions(Amazon.ElasticMapReduce.Model.Command[])"> <summary> Sets the BootstrapActions property </summary> <param name="bootstrapActions">The values to add to the BootstrapActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResult.WithBootstrapActions(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.Command})"> <summary> Sets the BootstrapActions property </summary> <param name="bootstrapActions">The values to add to the BootstrapActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResult.BootstrapActions"> <summary> Gets and sets the property BootstrapActions. <para> The bootstrap actions associated with the cluster . </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListBootstrapActionsResult.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve . </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListClustersRequest"> <summary> Container for the parameters to the ListClusters operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersRequest.WithClusterStates(System.String[])"> <summary> Sets the ClusterStates property </summary> <param name="clusterStates">The values to add to the ClusterStates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersRequest.WithClusterStates(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the ClusterStates property </summary> <param name="clusterStates">The values to add to the ClusterStates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersRequest.WithCreatedAfter(System.DateTime)"> <summary> Sets the CreatedAfter property </summary> <param name="createdAfter">The value to set for the CreatedAfter property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersRequest.WithCreatedBefore(System.DateTime)"> <summary> Sets the CreatedBefore property </summary> <param name="createdBefore">The value to set for the CreatedBefore property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListClustersRequest.ClusterStates"> <summary> Gets and sets the property ClusterStates. <para> The cluster state filters to apply when listing clusters. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListClustersRequest.CreatedAfter"> <summary> Gets and sets the property CreatedAfter. <para> The creation date and time beginning value filter for listing clusters . </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListClustersRequest.CreatedBefore"> <summary> Gets and sets the property CreatedBefore. <para> The creation date and time end value filter for listing clusters . </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListClustersRequest.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListClustersResponse"> <summary> Returns information about the ListClustersResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListClustersResponse.ListClustersResult"> <summary> Gets and sets the ListClustersResult property. Represents the output of a ListClusters operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListClustersResult"> <summary> This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersResult.WithClusters(Amazon.ElasticMapReduce.Model.ClusterSummary[])"> <summary> Sets the Clusters property </summary> <param name="clusters">The values to add to the Clusters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersResult.WithClusters(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.ClusterSummary})"> <summary> Sets the Clusters property </summary> <param name="clusters">The values to add to the Clusters collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListClustersResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListClustersResult.Clusters"> <summary> Gets and sets the property Clusters. <para> The list of clusters for the account based on the given filters. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListClustersResult.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest"> <summary> Container for the parameters to the ListInstanceGroups operation. Provides all available details about the instance groups in a cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest.WithClusterId(System.String)"> <summary> Sets the ClusterId property </summary> <param name="clusterId">The value to set for the ClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest.ClusterId"> <summary> Gets and sets the property ClusterId. <para> The identifier of the cluster for which to list the instance groups. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstanceGroupsRequest.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResponse"> <summary> Returns information about the ListInstanceGroupsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResponse.ListInstanceGroupsResult"> <summary> Gets and sets the ListInstanceGroupsResult property. Represents the output of a ListInstanceGroups operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResult"> <summary> This input determines which instance groups to retrieve. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResult.WithInstanceGroups(Amazon.ElasticMapReduce.Model.InstanceGroup[])"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResult.WithInstanceGroups(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.InstanceGroup})"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResult.InstanceGroups"> <summary> Gets and sets the property InstanceGroups. <para> The list of instance groups for the cluster and given filters. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstanceGroupsResult.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListInstancesRequest"> <summary> Container for the parameters to the ListInstances operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesRequest.WithClusterId(System.String)"> <summary> Sets the ClusterId property </summary> <param name="clusterId">The value to set for the ClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesRequest.WithInstanceGroupId(System.String)"> <summary> Sets the InstanceGroupId property </summary> <param name="instanceGroupId">The value to set for the InstanceGroupId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesRequest.WithInstanceGroupTypes(System.String[])"> <summary> Sets the InstanceGroupTypes property </summary> <param name="instanceGroupTypes">The values to add to the InstanceGroupTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesRequest.WithInstanceGroupTypes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the InstanceGroupTypes property </summary> <param name="instanceGroupTypes">The values to add to the InstanceGroupTypes collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstancesRequest.ClusterId"> <summary> Gets and sets the property ClusterId. <para> The identifier of the cluster for which to list the instances. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstancesRequest.InstanceGroupId"> <summary> Gets and sets the property InstanceGroupId. <para> The identifier of the instance group for which to list the instances. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstancesRequest.InstanceGroupTypes"> <summary> Gets and sets the property InstanceGroupTypes. <para> The type of instance group for which to list the instances. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstancesRequest.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListInstancesResponse"> <summary> Returns information about the ListInstancesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstancesResponse.ListInstancesResult"> <summary> Gets and sets the ListInstancesResult property. Represents the output of a ListInstances operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListInstancesResult"> <summary> This output contains the list of instances. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesResult.WithInstances(Amazon.ElasticMapReduce.Model.Instance[])"> <summary> Sets the Instances property </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesResult.WithInstances(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.Instance})"> <summary> Sets the Instances property </summary> <param name="instances">The values to add to the Instances collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListInstancesResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstancesResult.Instances"> <summary> Gets and sets the property Instances. <para> The list of instances for the cluster and given filters. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListInstancesResult.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListStepsRequest"> <summary> Container for the parameters to the ListSteps operation. Provides a list of steps for the cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListStepsRequest.WithClusterId(System.String)"> <summary> Sets the ClusterId property </summary> <param name="clusterId">The value to set for the ClusterId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListStepsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListStepsRequest.WithStepStates(System.String[])"> <summary> Sets the StepStates property </summary> <param name="stepStates">The values to add to the StepStates collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListStepsRequest.WithStepStates(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the StepStates property </summary> <param name="stepStates">The values to add to the StepStates collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListStepsRequest.ClusterId"> <summary> Gets and sets the property ClusterId. <para> The identifier of the cluster for which to list the steps. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListStepsRequest.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListStepsRequest.StepStates"> <summary> Gets and sets the property StepStates. <para> The filter to limit the step list based on certain states. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListStepsResponse"> <summary> Returns information about the ListStepsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListStepsResponse.ListStepsResult"> <summary> Gets and sets the ListStepsResult property. Represents the output of a ListSteps operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ListStepsResult"> <summary> This output contains the list of steps. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListStepsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListStepsResult.WithSteps(Amazon.ElasticMapReduce.Model.StepSummary[])"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ListStepsResult.WithSteps(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.StepSummary})"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListStepsResult.Marker"> <summary> Gets and sets the property Marker. <para> The pagination token that indicates the next set of results to retrieve. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ListStepsResult.Steps"> <summary> Gets and sets the property Steps. <para> The filtered list of steps for the cluster. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest"> <summary> Container for the parameters to the ModifyInstanceGroups operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest.WithInstanceGroups(Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig[])"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest.WithInstanceGroups(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.InstanceGroupModifyConfig})"> <summary> Sets the InstanceGroups property </summary> <param name="instanceGroups">The values to add to the InstanceGroups collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsRequest.InstanceGroups"> <summary> Gets and sets the property InstanceGroups. <para> Instance groups to change. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ModifyInstanceGroupsResponse"> <summary> Returns information about the ModifyInstanceGroupsResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.PlacementType"> <summary> The Amazon EC2 location for the job flow. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.PlacementType.WithAvailabilityZone(System.String)"> <summary> Sets the AvailabilityZone property </summary> <param name="availabilityZone">The value to set for the AvailabilityZone property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.PlacementType.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Amazon EC2 Availability Zone for the job flow. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.RemoveTagsRequest"> <summary> Container for the parameters to the RemoveTags operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.RemoveTagsRequest.WithResourceId(System.String)"> <summary> Sets the ResourceId property </summary> <param name="resourceId">The value to set for the ResourceId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RemoveTagsRequest.WithTagKeys(System.String[])"> <summary> Sets the TagKeys property </summary> <param name="tagKeys">The values to add to the TagKeys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RemoveTagsRequest.WithTagKeys(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the TagKeys property </summary> <param name="tagKeys">The values to add to the TagKeys collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.RemoveTagsRequest.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RemoveTagsRequest.TagKeys"> <summary> Gets and sets the property TagKeys. <para> A list of tag keys to remove from a resource. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.RemoveTagsResponse"> <summary> Returns information about the RemoveTagsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RemoveTagsResponse.RemoveTagsResult"> <summary> Gets and sets the RemoveTagsResult property. Represents the output of a RemoveTags operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.RemoveTagsResult"> <summary> This output indicates the result of removing tags from a resource. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.OnArrested"> <summary> The action to take if your step is waiting for the instance group to start and it enters the Arrested state. <para> Fail - Fail the step. Wait - Continue waiting until the instance group is no longer arrested (requires manual intervention). Continue - Proceed onto the next step. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.OnFailure"> <summary> Action to take if there is a failure modifying your cluster composition. Fail - Fail the step. Continue - Proceed on to the next step. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep"> <summary> This class provides some helper methods for creating a Resize Job Flow step as part of your job flow. The resize step can be used to automatically adjust the composition of your cluster while it is running. For example, if you have a large workflow with different compute requirements, you can use this step to automatically add a task instance group before your most compute intensive step. <code> AWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey); AmazonElasticMapReduce emr = new AmazonElasticMapReduceClient(credentials); HadoopJarStepConfig config = new ResizeJobFlowStep() .WithResizeAction(new ModifyInstanceGroup() .WithInstanceGroup("core") .WithInstanceCount(10)) .WithResizeAction(new AddInstanceGroup() .WithInstanceGroup("task") .WithInstanceCount(10) .WithInstanceType("m1.small")) .WithOnArrested(OnArrested.Continue) .WithOnFailure(OnFailure.Continue) .ToHadoopJarStepConfig(); StepConfig resizeJobFlow = new StepConfig { Name = "Resize job flow", ActionOnFailure = "TERMINATE_JOB_FLOW", HadoopJarStep = config }; RunJobFlowRequest request = new RunJobFlowRequest { Name = "Resize job flow", Steps = new List<StepConfig> { resizeJobFlow }, LogUri = "s3://log-bucket/", Instances = new JobFlowInstancesConfig { Ec2KeyName = "keypair", HadoopVersion = "0.20", InstanceCount = 5, KeepJobFlowAliveWhenNoSteps = true, MasterInstanceType = "m1.small", SlaveInstanceType = "m1.small" } }; RunJobFlowResult result = emr.RunJobFlow(request).RunJobFlowResult; </code> </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep.#ctor"> <summary> Creates a new ResizeJobFlowStep using the default Elastic Map Reduce bucket (us-east-1.elasticmapreduce) for the default (us-east-1) region. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep.#ctor(System.String)"> <summary> Creates a new ResizeJobFlowStep using the specified Amazon S3 bucket to load resources. <para> The official bucket format is "<region>.elasticmapreduce", so if you're using the us-east-1 region, you should use the bucket "us-east-1.elasticmapreduce". </para> </summary> <param name="bucket">The Amazon S3 bucket from which to load resources.</param> </member> <member name="M:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep.WithResizeAction(Amazon.ElasticMapReduce.Model.ResizeAction)"> <summary> Add a new action for this step to perform. These actions can be to modify or add instance groups. This step supports multiple actions, but requires at least one be specified. </summary> <param name="resizeAction">An instance of ResizeAction defining the change.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep.WithWait(System.Boolean)"> <summary> Specifies whether the step should wait for the modification to complete or if it should just continue onto the next step once the modification request is received. Defaults to true. </summary> <param name="wait">Whether this step should wait for the modification to complete.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep.WithOnArrested(Amazon.ElasticMapReduce.Model.OnArrested)"> <summary> What action this step should take if any of the instance group modifications result in the instance group entering Arrested state. This can happen when the bootstrap actions on the newly launched instances are continuously failing. </summary> <param name="onArrested">OnArrested enum specifying which action to take</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep.WithOnFailure(Amazon.ElasticMapReduce.Model.OnFailure)"> <summary> What action this step should take if the modification fails. This can happen when you request to perform an invalid action, such as shrink a core instance group. </summary> <param name="onFailure">OnFailure enum specifying which action to take.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ResizeJobFlowStep.ToHadoopJarStepConfig"> <summary> Creates the final HadoopJarStepConfig once you are done configuring the step. You can use this as you would any other HadoopJarStepConfig. </summary> <returns>HadoopJarStepConfig configured to perform the specified actions.</returns> </member> <member name="T:Amazon.ElasticMapReduce.Model.ModifyInstanceGroup"> Class representing a change to an existing instance group. </member> <member name="M:Amazon.ElasticMapReduce.Model.ModifyInstanceGroup.WithInstanceGroup(System.String)"> <summary> Set the identification for the instance group to modify. You can specify either core or task if there is only one instance group of that role. Otherwise you can specify the instance group ID (such as ig-ABABABABABAB). </summary> <param name="instanceGroup">Identifier for the instance group.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ModifyInstanceGroup.WithInstanceCount(System.Int32)"> <summary> Specify the new size of the instance group. </summary> <param name="instanceCount">Target size of the instance group.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="T:Amazon.ElasticMapReduce.Model.AddInstanceGroup"> <summary> Class representing creating a new instance group. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroup.WithInstanceGroup(System.String)"> <summary> Specify the role of the new instance group (core, task). </summary> <param name="instanceGroup">New instance group's role.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroup.WithInstanceCount(System.Int32)"> <summary> Specify the count of the new instance group. </summary> <param name="instanceCount">Target instance group size.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.AddInstanceGroup.WithInstanceType(System.String)"> <summary> Specify the instance type to use for this instance group. </summary> <param name="instanceType">Instance type.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="T:Amazon.ElasticMapReduce.Model.RunJobFlowRequest"> <summary> Container for the parameters to the RunJobFlow operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithAdditionalInfo(System.String)"> <summary> Sets the AdditionalInfo property </summary> <param name="additionalInfo">The value to set for the AdditionalInfo property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithAmiVersion(System.String)"> <summary> Sets the AmiVersion property </summary> <param name="amiVersion">The value to set for the AmiVersion property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithBootstrapActions(Amazon.ElasticMapReduce.Model.BootstrapActionConfig[])"> <summary> Sets the BootstrapActions property </summary> <param name="bootstrapActions">The values to add to the BootstrapActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithBootstrapActions(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.BootstrapActionConfig})"> <summary> Sets the BootstrapActions property </summary> <param name="bootstrapActions">The values to add to the BootstrapActions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithInstances(Amazon.ElasticMapReduce.Model.JobFlowInstancesConfig)"> <summary> Sets the Instances property </summary> <param name="instances">The value to set for the Instances property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithJobFlowRole(System.String)"> <summary> Sets the JobFlowRole property </summary> <param name="jobFlowRole">The value to set for the JobFlowRole property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithLogUri(System.String)"> <summary> Sets the LogUri property </summary> <param name="logUri">The value to set for the LogUri property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithNewSupportedProducts(Amazon.ElasticMapReduce.Model.SupportedProductConfig[])"> <summary> Sets the NewSupportedProducts property </summary> <param name="newSupportedProducts">The values to add to the NewSupportedProducts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithNewSupportedProducts(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.SupportedProductConfig})"> <summary> Sets the NewSupportedProducts property </summary> <param name="newSupportedProducts">The values to add to the NewSupportedProducts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithServiceRole(System.String)"> <summary> Sets the ServiceRole property </summary> <param name="serviceRole">The value to set for the ServiceRole property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithSteps(Amazon.ElasticMapReduce.Model.StepConfig[])"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithSteps(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.StepConfig})"> <summary> Sets the Steps property </summary> <param name="steps">The values to add to the Steps collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithSupportedProducts(System.String[])"> <summary> Sets the SupportedProducts property </summary> <param name="supportedProducts">The values to add to the SupportedProducts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithSupportedProducts(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the SupportedProducts property </summary> <param name="supportedProducts">The values to add to the SupportedProducts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithTags(Amazon.ElasticMapReduce.Model.Tag[])"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithTags(System.Collections.Generic.IEnumerable{Amazon.ElasticMapReduce.Model.Tag})"> <summary> Sets the Tags property </summary> <param name="tags">The values to add to the Tags collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.WithVisibleToAllUsers(System.Boolean)"> <summary> Sets the VisibleToAllUsers property </summary> <param name="visibleToAllUsers">The value to set for the VisibleToAllUsers property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.AdditionalInfo"> <summary> Gets and sets the property AdditionalInfo. <para> A JSON string for selecting additional features. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.AmiVersion"> <summary> Gets and sets the property AmiVersion. <para> The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid: </para> <ul> <li>"latest" (uses the latest AMI)</li> <li>The version number of the AMI to use, for example, "2.0"</li> </ul> <para> If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the <a>JobFlowInstancesConfig</a> <code>HadoopVersion</code> parameter to modify the version of Hadoop from the defaults shown above. </para> <para> For details about the AMI versions currently supported by Amazon Elastic MapReduce, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/EnvironmentConfig_AMIVersion.html#ami-versions-supported">AMI Versions Supported in Elastic MapReduce</a> in the <i>Amazon Elastic MapReduce Developer's Guide.</i> </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.BootstrapActions"> <summary> Gets and sets the property BootstrapActions. <para> A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.Instances"> <summary> Gets and sets the property Instances. <para> A specification of the number and type of Amazon EC2 instances on which to run the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.JobFlowRole"> <summary> Gets and sets the property JobFlowRole. <para> An IAM role for the job flow. The EC2 instances of the job flow assume this role. The default role is <code>EMRJobflowDefault</code>. In order to use the default role, you must have already created it using the CLI. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.LogUri"> <summary> Gets and sets the property LogUri. <para> The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.NewSupportedProducts"> <summary> Gets and sets the property NewSupportedProducts. <para> A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-mapr.html">Launch a Job Flow on the MapR Distribution for Hadoop</a>. Currently supported values are: </para> <ul> <li>"mapr-m3" - launch the job flow using MapR M3 Edition.</li> <li>"mapr-m5" - launch the job flow using MapR M5 Edition.</li> <li>"mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.ServiceRole"> <summary> Gets and sets the property ServiceRole. <para> IAM role that Amazon ElasticMapReduce will assume to work with AWS resources on your behalf. You may set this parameter to the name of an existing IAM role. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.Steps"> <summary> Gets and sets the property Steps. <para> A list of steps to be executed by the job flow. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.SupportedProducts"> <summary> Gets and sets the property SupportedProducts. <para> A list of strings that indicates third-party software to use with the job flow. For more information, go to <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-supported-products.html">Use Third Party Applications with Amazon EMR</a>. Currently supported values are: </para> <ul> <li>"mapr-m3" - launch the job flow using MapR M3 Edition.</li> <li>"mapr-m5" - launch the job flow using MapR M5 Edition.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.Tags"> <summary> Gets and sets the property Tags. <para> A list of tags to associate with a cluster and propagate to Amazon EC2 instances. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowRequest.VisibleToAllUsers"> <summary> Gets and sets the property VisibleToAllUsers. <para> Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to <code>true</code>, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to <code>false</code>, only the IAM user that created the job flow can view and manage it. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.RunJobFlowResponse"> <summary> Returns information about the RunJobFlowResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowResponse.RunJobFlowResult"> <summary> Gets and sets the RunJobFlowResult property. Represents the output of a RunJobFlow operation. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.RunJobFlowResult"> <summary> The result of the <a>RunJobFlow</a> operation. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.RunJobFlowResult.WithJobFlowId(System.String)"> <summary> Sets the JobFlowId property </summary> <param name="jobFlowId">The value to set for the JobFlowId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.RunJobFlowResult.JobFlowId"> <summary> Gets and sets the property JobFlowId. <para> An unique identifier for the job flow. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.ScriptBootstrapActionConfig"> <summary> Configuration of the script to run during a bootstrap action. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.ScriptBootstrapActionConfig.WithArgs(System.String[])"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ScriptBootstrapActionConfig.WithArgs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.ScriptBootstrapActionConfig.WithPath(System.String)"> <summary> Sets the Path property </summary> <param name="path">The value to set for the Path property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.ScriptBootstrapActionConfig.Args"> <summary> Gets and sets the property Args. <para> A list of command line arguments to pass to the bootstrap action script. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.ScriptBootstrapActionConfig.Path"> <summary> Gets and sets the property Path. <para> Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest"> <summary> Container for the parameters to the SetTerminationProtection operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest.WithJobFlowIds(System.String[])"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest.WithJobFlowIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest.WithTerminationProtected(System.Boolean)"> <summary> Sets the TerminationProtected property </summary> <param name="terminationProtected">The value to set for the TerminationProtected property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest.JobFlowIds"> <summary> Gets and sets the property JobFlowIds. <para> A list of strings that uniquely identify the job flows to protect. This identifier is returned by <a>RunJobFlow</a> and can also be obtained from <a>DescribeJobFlows</a> . </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.SetTerminationProtectionRequest.TerminationProtected"> <summary> Gets and sets the property TerminationProtected. <para> A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.SetTerminationProtectionResponse"> <summary> Returns information about the SetTerminationProtectionResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest"> <summary> Container for the parameters to the SetVisibleToAllUsers operation. 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest.WithJobFlowIds(System.String[])"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest.WithJobFlowIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest.WithVisibleToAllUsers(System.Boolean)"> <summary> Sets the VisibleToAllUsers property </summary> <param name="visibleToAllUsers">The value to set for the VisibleToAllUsers property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest.JobFlowIds"> <summary> Gets and sets the property JobFlowIds. <para> Identifiers of the job flows to receive the new visibility setting. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersRequest.VisibleToAllUsers"> <summary> Gets and sets the property VisibleToAllUsers. <para> Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the job flows. If it is set to False, only the IAM user that created a job flow can view and manage it. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.SetVisibleToAllUsersResponse"> <summary> Returns information about the SetVisibleToAllUsersResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Step"> <summary> This represents a step in a cluster. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.Step.WithActionOnFailure(System.String)"> <summary> Sets the ActionOnFailure property </summary> <param name="actionOnFailure">The value to set for the ActionOnFailure property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Step.WithConfig(Amazon.ElasticMapReduce.Model.HadoopStepConfig)"> <summary> Sets the Config property </summary> <param name="config">The value to set for the Config property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Step.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Step.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Step.WithStatus(Amazon.ElasticMapReduce.Model.StepStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.Step.ActionOnFailure"> <summary> Gets and sets the property ActionOnFailure. <para> This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Step.Config"> <summary> Gets and sets the property Config. <para> The Hadoop job configuration of the cluster step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Step.Id"> <summary> Gets and sets the property Id. <para> The identifier of the cluster step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Step.Name"> <summary> Gets and sets the property Name. <para> The name of the cluster step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Step.Status"> <summary> Gets and sets the property Status. <para> The current execution status details of the cluster step. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepConfig"> <summary> Specification of a job flow step. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepConfig.WithActionOnFailure(System.String)"> <summary> Sets the ActionOnFailure property </summary> <param name="actionOnFailure">The value to set for the ActionOnFailure property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepConfig.WithHadoopJarStep(Amazon.ElasticMapReduce.Model.HadoopJarStepConfig)"> <summary> Sets the HadoopJarStep property </summary> <param name="hadoopJarStep">The value to set for the HadoopJarStep property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepConfig.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepConfig.ActionOnFailure"> <summary> Gets and sets the property ActionOnFailure. <para> The action to take if the job flow step fails. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepConfig.HadoopJarStep"> <summary> Gets and sets the property HadoopJarStep. <para> The JAR file used for the job flow step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepConfig.Name"> <summary> Gets and sets the property Name. <para> The name of the job flow step. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepDetail"> <summary> Combines the execution state and configuration of a step. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepDetail.WithExecutionStatusDetail(Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail)"> <summary> Sets the ExecutionStatusDetail property </summary> <param name="executionStatusDetail">The value to set for the ExecutionStatusDetail property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepDetail.WithStepConfig(Amazon.ElasticMapReduce.Model.StepConfig)"> <summary> Sets the StepConfig property </summary> <param name="stepConfig">The value to set for the StepConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepDetail.ExecutionStatusDetail"> <summary> Gets and sets the property ExecutionStatusDetail. <para> The description of the step status. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepDetail.StepConfig"> <summary> Gets and sets the property StepConfig. <para> The step configuration. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail"> <summary> The execution state of a step. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.WithEndDateTime(System.DateTime)"> <summary> Sets the EndDateTime property </summary> <param name="endDateTime">The value to set for the EndDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.WithLastStateChangeReason(System.String)"> <summary> Sets the LastStateChangeReason property </summary> <param name="lastStateChangeReason">The value to set for the LastStateChangeReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.WithStartDateTime(System.DateTime)"> <summary> Sets the StartDateTime property </summary> <param name="startDateTime">The value to set for the StartDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The creation date and time of the step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.EndDateTime"> <summary> Gets and sets the property EndDateTime. <para> The completion date and time of the step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.LastStateChangeReason"> <summary> Gets and sets the property LastStateChangeReason. <para> A description of the step's current state. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.StartDateTime"> <summary> Gets and sets the property StartDateTime. <para> The start date and time of the step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepExecutionStatusDetail.State"> <summary> Gets and sets the property State. <para> The state of the job flow step. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepFactory"> <summary> This class provides helper methods for creating common Elastic MapReduce step types. To use StepFactory, you should construct it with the appropriate bucket for your region. The official bucket format is "<region>.elasticmapreduce", so us-east-1 would use the bucket "us-east-1.elasticmapreduce". </summary> <example>Create an interactive Hive job flow with debugging enabled: <code> AmazonElasticMapReduce emr = AWSClientFactory.CreateAmazonElasticMapReduceClient(accessKey, secretKey); StepFactory stepFactory = new StepFactory(); StepConfig enableDebugging = new StepConfig { Name = "Enable Debugging", ActionOnFailure = "TERMINATE_JOB_FLOW", HadoopJarStep = stepFactory.NewEnableDebuggingStep() }; StepConfig installHive = new StepConfig { Name = "Install Hive", ActionOnFailure = "TERMINATE_JOB_FLOW", HadoopJarStep = stepFactory.NewInstallHiveStep() }; RunJobFlowRequest request = new RunJobFlowRequest { Name = "Hive Interactive", Steps = new List<StepConfig> { enableDebugging, installHive }, LogUri = "s3://log-bucket/", Instances = new JobFlowInstancesConfig { Ec2KeyName = "keypair", HadoopVersion = "0.20", InstanceCount = 5, KeepJobFlowAliveWhenNoSteps = true, MasterInstanceType = "m1.small", SlaveInstanceType = "m1.small" } }; RunJobFlowResponse response = emr.RunJobFlow(request); </code> </example> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewScriptRunnerStep(System.String,System.String[])"> <summary> Runs a specified script on the master node of your cluster. </summary> <param name="script">The script to run</param> <param name="args">Arguments to be passed to the script.</param> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewEnableDebuggingStep"> <summary> When run as the first step in your job flow, enables the Hadoop debugging UI in the AWS Management Console. </summary> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewInstallHiveStep(Amazon.ElasticMapReduce.Model.StepFactory.HiveVersion[])"> <summary> Step that installs Hive on your job flow. </summary> <param name="hiveVersions">The versions of Hive to install.</param> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewInstallHiveStep"> <summary> Step that installs Hive on your job flow. </summary> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewRunHiveScriptStep(System.String,System.String[])"> <summary> Step that runs a Hive script on your job flow. </summary> <param name="script">The script to run.</param> <param name="args">Arguments that get passed to the script.</param> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewRunHiveScriptStepVersioned(System.String,System.String,System.String[])"> <summary> Step that runs a Hive script on your job flow with a specific verson of Hive. </summary> <param name="script">The script to run.</param> <param name="version">The version of Hive to run.</param> <param name="args">Arguments that get passed to the script.</param> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewInstallPigStep"> <summary> Step that installs Pig on your job flow. </summary> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepFactory.NewRunPigScriptStep(System.String,System.String[])"> <summary> Step that runs a Pig script on your job flow. </summary> <param name="script">The script to run.</param> <param name="args">Arguments that get passed to the script.</param> <returns>HadoopJarStepConfig that can be passed to your job flow.</returns> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepFactory.HiveVersion"> <summary> The available Hive versions. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepStateChangeReason"> <summary> The details of the step state change reason. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepStateChangeReason.WithCode(System.String)"> <summary> Sets the Code property </summary> <param name="code">The value to set for the Code property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepStateChangeReason.WithMessage(System.String)"> <summary> Sets the Message property </summary> <param name="message">The value to set for the Message property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepStateChangeReason.Code"> <summary> Gets and sets the property Code. <para> The programmable code for the state change reason. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepStateChangeReason.Message"> <summary> Gets and sets the property Message. <para> The descriptive message for the state change reason. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepStatus"> <summary> The execution status details of the cluster step. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepStatus.WithState(System.String)"> <summary> Sets the State property </summary> <param name="state">The value to set for the State property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepStatus.WithStateChangeReason(Amazon.ElasticMapReduce.Model.StepStateChangeReason)"> <summary> Sets the StateChangeReason property </summary> <param name="stateChangeReason">The value to set for the StateChangeReason property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepStatus.WithTimeline(Amazon.ElasticMapReduce.Model.StepTimeline)"> <summary> Sets the Timeline property </summary> <param name="timeline">The value to set for the Timeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepStatus.State"> <summary> Gets and sets the property State. <para> The execution state of the cluster step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepStatus.StateChangeReason"> <summary> Gets and sets the property StateChangeReason. <para> The reason for the step execution status change. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepStatus.Timeline"> <summary> Gets and sets the property Timeline. <para> The timeline of the cluster step status over time. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepSummary"> <summary> The summary of the cluster step. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepSummary.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepSummary.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepSummary.WithStatus(Amazon.ElasticMapReduce.Model.StepStatus)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepSummary.Id"> <summary> Gets and sets the property Id. <para> The identifier of the cluster step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepSummary.Name"> <summary> Gets and sets the property Name. <para> The name of the cluster step. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepSummary.Status"> <summary> Gets and sets the property Status. <para> The current execution status details of the cluster step. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StepTimeline"> <summary> The timeline of the cluster step lifecycle. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepTimeline.WithCreationDateTime(System.DateTime)"> <summary> Sets the CreationDateTime property </summary> <param name="creationDateTime">The value to set for the CreationDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepTimeline.WithEndDateTime(System.DateTime)"> <summary> Sets the EndDateTime property </summary> <param name="endDateTime">The value to set for the EndDateTime property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StepTimeline.WithStartDateTime(System.DateTime)"> <summary> Sets the StartDateTime property </summary> <param name="startDateTime">The value to set for the StartDateTime property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepTimeline.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The date and time when the cluster step was created. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepTimeline.EndDateTime"> <summary> Gets and sets the property EndDateTime. <para> The date and time when the cluster step execution completed or failed. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StepTimeline.StartDateTime"> <summary> Gets and sets the property StartDateTime. <para> The date and time when the cluster step execution started. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.StreamingStep"> <summary> Class that makes it easy to define Hadoop Streaming steps. <para> See also: <a href="http://hadoop.apache.org/common/docs/r0.20.2/streaming.html">Hadoop Streaming</a> </para> <code> AWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey); AmazonElasticMapReduce emr = new AmazonElasticMapReduceClient(credentials); HadoopJarStepConfig config = new StreamingStep { Inputs = new List<string> { "s3://elasticmapreduce/samples/wordcount/input" }, Output = "s3://my-bucket/output/", Mapper = "s3://elasticmapreduce/samples/wordcount/wordSplitter.py", Reducer = "aggregate" }.ToHadoopJarStepConfig(); StepConfig wordCount = new StepConfig { Name = "Word Count", ActionOnFailure = "TERMINATE_JOB_FLOW", HadoopJarStep = config }; RunJobFlowRequest request = new RunJobFlowRequest { Name = "Word Count", Steps = new List<StepConfig> { wordCount }, LogUri = "s3://log-bucket/", Instances = new JobFlowInstancesConfig { Ec2KeyName = "keypair", HadoopVersion = "0.20", InstanceCount = 5, KeepJobFlowAliveWhenNoSteps = true, MasterInstanceType = "m1.small", SlaveInstanceType = "m1.small" } }; RunJobFlowResult result = emr.RunJobFlow(request).RunJobFlowResult; </code> </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StreamingStep.#ctor"> <summary> Creates a new default StreamingStep. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.StreamingStep.WithInputs(System.String[])"> <summary> Add more input paths to this step. </summary> <param name="inputs">inputs a list of inputs to this step.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StreamingStep.WithOutput(System.String)"> <summary> Set the output path for this step. </summary> <param name="output">The output path.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StreamingStep.WithMapper(System.String)"> <summary> Set the mapper. </summary> <param name="mapper">The mapper.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StreamingStep.WithReducer(System.String)"> <summary> Set the reducer. </summary> <param name="reducer">The reducer.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StreamingStep.WithHadoopConfig(System.String,System.String)"> <summary> Add a Hadoop config override (-D value) </summary> <param name="key">Hadoop configuration key.</param> <param name="value">Configuration value.</param> <returns>A reference to this updated object so that method calls can be chained together.</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.StreamingStep.ToHadoopJarStepConfig"> <summary> Creates the final HadoopJarStepConfig once you are done configuring the step. You can use this as you would any other HadoopJarStepConfig. </summary> <returns>HadoopJarStepConfig representing this streaming step.</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.StreamingStep.Inputs"> <summary> Gets and sets list of step input paths. </summary> <value>The inputs.</value> </member> <member name="P:Amazon.ElasticMapReduce.Model.StreamingStep.Output"> <summary> Gets and sets the output path. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StreamingStep.Mapper"> <summary> Gets and sets the mapper. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StreamingStep.Reducer"> <summary> Gets and sets the reducer. </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.StreamingStep.HadoopConfig"> <summary> Gets and sets the hadoopConfig. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.SupportedProductConfig"> <summary> The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments. </summary> </member> <member name="M:Amazon.ElasticMapReduce.Model.SupportedProductConfig.WithArgs(System.String[])"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.SupportedProductConfig.WithArgs(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Args property </summary> <param name="args">The values to add to the Args collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.SupportedProductConfig.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.SupportedProductConfig.Args"> <summary> Gets and sets the property Args. <para> The list of user-supplied arguments. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.SupportedProductConfig.Name"> <summary> Gets and sets the property Name. <para> The name of the product configuration. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Tag"> <summary> A key/value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clu\sters 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.Tag.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.Tag.WithValue(System.String)"> <summary> Sets the Value property </summary> <param name="value">The value to set for the Value property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> A user-defined key, which is the minimum required information for a valid tag. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. </para> </summary> </member> <member name="P:Amazon.ElasticMapReduce.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> A user-defined value, which is optional in a tag. For more information, see <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-plan-tags.html">Tagging Amazon EMR Resources</a>. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest"> <summary> Container for the parameters to the TerminateJobFlows operation. 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 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> </member> <member name="M:Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest.WithJobFlowIds(System.String[])"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest.WithJobFlowIds(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the JobFlowIds property </summary> <param name="jobFlowIds">The values to add to the JobFlowIds collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticMapReduce.Model.TerminateJobFlowsRequest.JobFlowIds"> <summary> Gets and sets the property JobFlowIds. <para> A list of job flows to be shutdown. </para> </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.TerminateJobFlowsResponse"> <summary> Returns information about the TerminateJobFlowsResult response and response metadata. </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddInstanceGroupsRequestMarshaller"> <summary> AddInstanceGroups Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddInstanceGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for AddInstanceGroups operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddInstanceGroupsResultUnmarshaller"> <summary> Response Unmarshaller for AddInstanceGroups Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddJobFlowStepsRequestMarshaller"> <summary> AddJobFlowSteps Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddJobFlowStepsResponseUnmarshaller"> <summary> Response Unmarshaller for AddJobFlowSteps operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddJobFlowStepsResultUnmarshaller"> <summary> Response Unmarshaller for AddJobFlowSteps Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddTagsRequestMarshaller"> <summary> AddTags Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddTagsResponseUnmarshaller"> <summary> Response Unmarshaller for AddTags operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.AddTagsResultUnmarshaller"> <summary> Response Unmarshaller for AddTags Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ApplicationUnmarshaller"> <summary> Response Unmarshaller for Application Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.BootstrapActionConfigUnmarshaller"> <summary> Response Unmarshaller for BootstrapActionConfig Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.BootstrapActionDetailUnmarshaller"> <summary> Response Unmarshaller for BootstrapActionDetail Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ClusterStateChangeReasonUnmarshaller"> <summary> Response Unmarshaller for ClusterStateChangeReason Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ClusterStatusUnmarshaller"> <summary> Response Unmarshaller for ClusterStatus Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ClusterSummaryUnmarshaller"> <summary> Response Unmarshaller for ClusterSummary Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ClusterTimelineUnmarshaller"> <summary> Response Unmarshaller for ClusterTimeline Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ClusterUnmarshaller"> <summary> Response Unmarshaller for Cluster Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.CommandUnmarshaller"> <summary> Response Unmarshaller for Command Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeClusterRequestMarshaller"> <summary> DescribeCluster Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeClusterResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCluster operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeClusterResultUnmarshaller"> <summary> Response Unmarshaller for DescribeCluster Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeJobFlowsRequestMarshaller"> <summary> DescribeJobFlows Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeJobFlowsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeJobFlows operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeJobFlowsResultUnmarshaller"> <summary> Response Unmarshaller for DescribeJobFlows Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeStepRequestMarshaller"> <summary> DescribeStep Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeStepResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStep operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.DescribeStepResultUnmarshaller"> <summary> Response Unmarshaller for DescribeStep Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.Ec2InstanceAttributesUnmarshaller"> <summary> Response Unmarshaller for Ec2InstanceAttributes Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.HadoopJarStepConfigUnmarshaller"> <summary> Response Unmarshaller for HadoopJarStepConfig Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.HadoopStepConfigUnmarshaller"> <summary> Response Unmarshaller for HadoopStepConfig Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceGroupDetailUnmarshaller"> <summary> Response Unmarshaller for InstanceGroupDetail Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceGroupStateChangeReasonUnmarshaller"> <summary> Response Unmarshaller for InstanceGroupStateChangeReason Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceGroupStatusUnmarshaller"> <summary> Response Unmarshaller for InstanceGroupStatus Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceGroupTimelineUnmarshaller"> <summary> Response Unmarshaller for InstanceGroupTimeline Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceGroupUnmarshaller"> <summary> Response Unmarshaller for InstanceGroup Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceStateChangeReasonUnmarshaller"> <summary> Response Unmarshaller for InstanceStateChangeReason Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceStatusUnmarshaller"> <summary> Response Unmarshaller for InstanceStatus Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceTimelineUnmarshaller"> <summary> Response Unmarshaller for InstanceTimeline Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.InstanceUnmarshaller"> <summary> Response Unmarshaller for Instance Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.JobFlowDetailUnmarshaller"> <summary> Response Unmarshaller for JobFlowDetail Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.JobFlowExecutionStatusDetailUnmarshaller"> <summary> Response Unmarshaller for JobFlowExecutionStatusDetail Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.JobFlowInstancesDetailUnmarshaller"> <summary> Response Unmarshaller for JobFlowInstancesDetail Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.KeyValueUnmarshaller"> <summary> Response Unmarshaller for KeyValue Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListBootstrapActionsRequestMarshaller"> <summary> ListBootstrapActions Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListBootstrapActionsResponseUnmarshaller"> <summary> Response Unmarshaller for ListBootstrapActions operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListBootstrapActionsResultUnmarshaller"> <summary> Response Unmarshaller for ListBootstrapActions Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListClustersRequestMarshaller"> <summary> ListClusters Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListClustersResponseUnmarshaller"> <summary> Response Unmarshaller for ListClusters operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListClustersResultUnmarshaller"> <summary> Response Unmarshaller for ListClusters Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListInstanceGroupsRequestMarshaller"> <summary> ListInstanceGroups Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListInstanceGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for ListInstanceGroups operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListInstanceGroupsResultUnmarshaller"> <summary> Response Unmarshaller for ListInstanceGroups Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListInstancesRequestMarshaller"> <summary> ListInstances Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for ListInstances operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListInstancesResultUnmarshaller"> <summary> Response Unmarshaller for ListInstances Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListStepsRequestMarshaller"> <summary> ListSteps Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListStepsResponseUnmarshaller"> <summary> Response Unmarshaller for ListSteps operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ListStepsResultUnmarshaller"> <summary> Response Unmarshaller for ListSteps Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ModifyInstanceGroupsRequestMarshaller"> <summary> ModifyInstanceGroups Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ModifyInstanceGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyInstanceGroups operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.PlacementTypeUnmarshaller"> <summary> Response Unmarshaller for PlacementType Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.RemoveTagsRequestMarshaller"> <summary> RemoveTags Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.RemoveTagsResponseUnmarshaller"> <summary> Response Unmarshaller for RemoveTags operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.RemoveTagsResultUnmarshaller"> <summary> Response Unmarshaller for RemoveTags Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.RunJobFlowRequestMarshaller"> <summary> RunJobFlow Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.RunJobFlowResponseUnmarshaller"> <summary> Response Unmarshaller for RunJobFlow operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.RunJobFlowResultUnmarshaller"> <summary> Response Unmarshaller for RunJobFlow Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.ScriptBootstrapActionConfigUnmarshaller"> <summary> Response Unmarshaller for ScriptBootstrapActionConfig Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.SetTerminationProtectionRequestMarshaller"> <summary> SetTerminationProtection Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.SetTerminationProtectionResponseUnmarshaller"> <summary> Response Unmarshaller for SetTerminationProtection operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.SetVisibleToAllUsersRequestMarshaller"> <summary> SetVisibleToAllUsers Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.SetVisibleToAllUsersResponseUnmarshaller"> <summary> Response Unmarshaller for SetVisibleToAllUsers operation </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepConfigUnmarshaller"> <summary> Response Unmarshaller for StepConfig Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepDetailUnmarshaller"> <summary> Response Unmarshaller for StepDetail Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepExecutionStatusDetailUnmarshaller"> <summary> Response Unmarshaller for StepExecutionStatusDetail Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepStateChangeReasonUnmarshaller"> <summary> Response Unmarshaller for StepStateChangeReason Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepStatusUnmarshaller"> <summary> Response Unmarshaller for StepStatus Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepSummaryUnmarshaller"> <summary> Response Unmarshaller for StepSummary Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepTimelineUnmarshaller"> <summary> Response Unmarshaller for StepTimeline Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.StepUnmarshaller"> <summary> Response Unmarshaller for Step Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.TagUnmarshaller"> <summary> Response Unmarshaller for Tag Object </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.TerminateJobFlowsRequestMarshaller"> <summary> TerminateJobFlows Request Marshaller </summary> </member> <member name="T:Amazon.ElasticMapReduce.Model.Internal.MarshallTransformations.TerminateJobFlowsResponseUnmarshaller"> <summary> Response Unmarshaller for TerminateJobFlows operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"> <summary> Implementation for accessing ElasticTranscoder AWS Elastic Transcoder Service <para> The AWS Elastic Transcoder Service. </para> </summary> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginCancelJob(Amazon.ElasticTranscoder.Model.CancelJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CancelJob operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelJob operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndCancelJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelJob.</param> <returns>Returns a CancelJobResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginCreateJob(Amazon.ElasticTranscoder.Model.CreateJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateJob operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateJob operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndCreateJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateJob.</param> <returns>Returns a CreateJobResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginCreatePipeline(Amazon.ElasticTranscoder.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndCreatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginCreatePreset(Amazon.ElasticTranscoder.Model.CreatePresetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CreatePreset operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePreset operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndCreatePreset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePreset.</param> <returns>Returns a CreatePresetResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginDeletePipeline(Amazon.ElasticTranscoder.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> <returns>Returns a DeletePipelineResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginDeletePreset(Amazon.ElasticTranscoder.Model.DeletePresetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the DeletePreset operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePreset operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndDeletePreset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePreset.</param> <returns>Returns a DeletePresetResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginListJobsByPipeline(Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobsByPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByPipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobsByPipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndListJobsByPipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobsByPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobsByPipeline.</param> <returns>Returns a ListJobsByPipelineResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginListJobsByStatus(Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobsByStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByStatus operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobsByStatus operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndListJobsByStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobsByStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobsByStatus.</param> <returns>Returns a ListJobsByStatusResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginListPipelines(Amazon.ElasticTranscoder.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelines operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndListPipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPipelines operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginListPresets(Amazon.ElasticTranscoder.Model.ListPresetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPresets operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListPresets operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPresets operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndListPresets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPresets operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPresets.</param> <returns>Returns a ListPresetsResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginReadJob(Amazon.ElasticTranscoder.Model.ReadJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReadJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ReadJob operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReadJob operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndReadJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReadJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReadJob.</param> <returns>Returns a ReadJobResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginReadPipeline(Amazon.ElasticTranscoder.Model.ReadPipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReadPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ReadPipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReadPipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndReadPipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReadPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReadPipeline.</param> <returns>Returns a ReadPipelineResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginReadPreset(Amazon.ElasticTranscoder.Model.ReadPresetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReadPreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ReadPreset operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReadPreset operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndReadPreset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReadPreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReadPreset.</param> <returns>Returns a ReadPresetResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginTestRole(Amazon.ElasticTranscoder.Model.TestRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TestRole operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the TestRole operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTestRole operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndTestRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TestRole operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTestRole.</param> <returns>Returns a TestRoleResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginUpdatePipeline(Amazon.ElasticTranscoder.Model.UpdatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndUpdatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipeline.</param> <returns>Returns a UpdatePipelineResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginUpdatePipelineNotifications(Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipelineNotifications operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineNotifications operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipelineNotifications operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndUpdatePipelineNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipelineNotifications operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipelineNotifications.</param> <returns>Returns a UpdatePipelineNotificationsResult from ElasticTranscoder.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.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.AmazonElasticTranscoder.BeginUpdatePipelineStatus(Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipelineStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineStatus operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipelineStatus operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoder.EndUpdatePipelineStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipelineStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipelineStatus.</param> <returns>Returns a UpdatePipelineStatusResult from ElasticTranscoder.</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="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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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.BeginCancelJob(Amazon.ElasticTranscoder.Model.CancelJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CancelJob operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelJob operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndCancelJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelJob.</param> <returns>Returns a CancelJobResult from ElasticTranscoder.</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.BeginCreateJob(Amazon.ElasticTranscoder.Model.CreateJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateJob operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateJob operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndCreateJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateJob.</param> <returns>Returns a CreateJobResult from ElasticTranscoder.</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.BeginCreatePipeline(Amazon.ElasticTranscoder.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndCreatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from ElasticTranscoder.</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.BeginCreatePreset(Amazon.ElasticTranscoder.Model.CreatePresetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the CreatePreset operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePreset operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndCreatePreset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePreset.</param> <returns>Returns a CreatePresetResult from ElasticTranscoder.</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.BeginDeletePipeline(Amazon.ElasticTranscoder.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> <returns>Returns a DeletePipelineResult from ElasticTranscoder.</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.BeginDeletePreset(Amazon.ElasticTranscoder.Model.DeletePresetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the DeletePreset operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePreset operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndDeletePreset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePreset.</param> <returns>Returns a DeletePresetResult from ElasticTranscoder.</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.BeginListJobsByPipeline(Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobsByPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByPipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobsByPipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndListJobsByPipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobsByPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobsByPipeline.</param> <returns>Returns a ListJobsByPipelineResult from ElasticTranscoder.</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.BeginListJobsByStatus(Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobsByStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListJobsByStatus operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobsByStatus operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndListJobsByStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobsByStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobsByStatus.</param> <returns>Returns a ListJobsByStatusResult from ElasticTranscoder.</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.BeginListPipelines(Amazon.ElasticTranscoder.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelines operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndListPipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPipelines operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from ElasticTranscoder.</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.BeginListPresets(Amazon.ElasticTranscoder.Model.ListPresetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPresets operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ListPresets operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPresets operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndListPresets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPresets operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPresets.</param> <returns>Returns a ListPresetsResult from ElasticTranscoder.</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.BeginReadJob(Amazon.ElasticTranscoder.Model.ReadJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReadJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ReadJob operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReadJob operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndReadJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReadJob operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReadJob.</param> <returns>Returns a ReadJobResult from ElasticTranscoder.</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.BeginReadPipeline(Amazon.ElasticTranscoder.Model.ReadPipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReadPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ReadPipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReadPipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndReadPipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReadPipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReadPipeline.</param> <returns>Returns a ReadPipelineResult from ElasticTranscoder.</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.BeginReadPreset(Amazon.ElasticTranscoder.Model.ReadPresetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReadPreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the ReadPreset operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReadPreset operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndReadPreset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReadPreset operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReadPreset.</param> <returns>Returns a ReadPresetResult from ElasticTranscoder.</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.BeginTestRole(Amazon.ElasticTranscoder.Model.TestRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TestRole operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the TestRole operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTestRole operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndTestRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TestRole operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTestRole.</param> <returns>Returns a TestRoleResult from ElasticTranscoder.</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.BeginUpdatePipeline(Amazon.ElasticTranscoder.Model.UpdatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipeline operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndUpdatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipeline operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipeline.</param> <returns>Returns a UpdatePipelineResult from ElasticTranscoder.</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.BeginUpdatePipelineNotifications(Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipelineNotifications operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineNotifications operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipelineNotifications operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndUpdatePipelineNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipelineNotifications operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipelineNotifications.</param> <returns>Returns a UpdatePipelineNotificationsResult from ElasticTranscoder.</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.BeginUpdatePipelineStatus(Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipelineStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipelineStatus operation on AmazonElasticTranscoderClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipelineStatus operation.</returns> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderClient.EndUpdatePipelineStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipelineStatus operation. <seealso cref="T:Amazon.ElasticTranscoder.AmazonElasticTranscoder"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipelineStatus.</param> <returns>Returns a UpdatePipelineStatusResult from ElasticTranscoder.</returns> </member> <member name="T:Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig"> <summary> Configuration for accessing Amazon ElasticTranscoder service </summary> </member> <member name="M:Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.ElasticTranscoder.AmazonElasticTranscoderConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.AccessDeniedException"> <summary> ElasticTranscoder exception </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.AccessDeniedException.#ctor(System.String)"> <summary> Constructs a new AccessDeniedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticTranscoder.Model.Artwork"> <summary> The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. <para> To remove artwork or leave the artwork empty, you can either set <code>Artwork</code> to null, or set the <code>Merge Policy</code> to "Replace" and use an empty <code>Artwork</code> array. </para> <para> To pass through existing artwork unchanged, set the <code>Merge Policy</code> to "Prepend", "Append", or "Fallback", and use an empty <code>Artwork</code> array. </para> </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Artwork.WithAlbumArtFormat(System.String)"> <summary> Sets the AlbumArtFormat property </summary> <param name="albumArtFormat">The value to set for the AlbumArtFormat property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Artwork.WithInputKey(System.String)"> <summary> Sets the InputKey property </summary> <param name="inputKey">The value to set for the InputKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Artwork.WithMaxHeight(System.String)"> <summary> Sets the MaxHeight property </summary> <param name="maxHeight">The value to set for the MaxHeight property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Artwork.WithMaxWidth(System.String)"> <summary> Sets the MaxWidth property </summary> <param name="maxWidth">The value to set for the MaxWidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Artwork.WithPaddingPolicy(System.String)"> <summary> Sets the PaddingPolicy property </summary> <param name="paddingPolicy">The value to set for the PaddingPolicy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Artwork.WithSizingPolicy(System.String)"> <summary> Sets the SizingPolicy property </summary> <param name="sizingPolicy">The value to set for the SizingPolicy property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Artwork.AlbumArtFormat"> <summary> Gets and sets the property AlbumArtFormat. <para> The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Artwork.InputKey"> <summary> Gets and sets the property InputKey. <para> The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by <code>PipelineId</code>; the <code>InputBucket</code> object in that pipeline identifies the bucket. </para> <para> If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Artwork.MaxHeight"> <summary> Gets and sets the property MaxHeight. <para> The maximum height of the output album art in pixels. If you specify <code>auto</code>, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Artwork.MaxWidth"> <summary> Gets and sets the property MaxWidth. <para> The maximum width of the output album art in pixels. If you specify <code>auto</code>, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Artwork.PaddingPolicy"> <summary> Gets and sets the property PaddingPolicy. <para> When you set <code>PaddingPolicy</code> to <code>Pad</code>, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Artwork.SizingPolicy"> <summary> Gets and sets the property SizingPolicy. <para> Specify one of the following values to control scaling of the output album art: </para> <para> <ul> <li><code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without exceeding the other value.</li> <li><code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. </li> <li><code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative proportions of the input art and the output art are different, the output art will be distorted.</li> <li><code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li> <li><code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.</li> <li><code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.</li> </ul> </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.AudioCodecOptions"> <summary> Options associated with your audio codec. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.AudioCodecOptions.WithProfile(System.String)"> <summary> Sets the Profile property </summary> <param name="profile">The value to set for the Profile property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.AudioCodecOptions.Profile"> <summary> Gets and sets the property Profile. <para> You can only choose an audio profile when you specify AAC for the value of Audio:Codec. </para> <para> Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles: </para> <ul> <li><code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select the profile based on the bit rate selected for the output file.</li> <li><code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than 64 kbps.</li> <li><code>HE-AAC</code>: Not supported on some older players and devices. Use for bitrates between 40 and 80 kbps.</li> <li><code>HE-AACv2</code>: Not supported on some players and devices. Use for bitrates less than 48 kbps.</li> </ul> <note> <para> If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required. </para> </note> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.AudioParameters"> <summary> Parameters required for transcoding audio. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.AudioParameters.WithBitRate(System.String)"> <summary> Sets the BitRate property </summary> <param name="bitRate">The value to set for the BitRate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.AudioParameters.WithChannels(System.String)"> <summary> Sets the Channels property </summary> <param name="channels">The value to set for the Channels property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.AudioParameters.WithCodec(System.String)"> <summary> Sets the Codec property </summary> <param name="codec">The value to set for the Codec property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.AudioParameters.WithCodecOptions(Amazon.ElasticTranscoder.Model.AudioCodecOptions)"> <summary> Sets the CodecOptions property </summary> <param name="codecOptions">The value to set for the CodecOptions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.AudioParameters.WithSampleRate(System.String)"> <summary> Sets the SampleRate property </summary> <param name="sampleRate">The value to set for the SampleRate property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.AudioParameters.BitRate"> <summary> Gets and sets the property BitRate. <para> The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.AudioParameters.Channels"> <summary> Gets and sets the property Channels. <para> The number of audio channels in the output file. Valid values include: </para> <para> <code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code> </para> <para> If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in the input file. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.AudioParameters.Codec"> <summary> Gets and sets the property Codec. <para> The audio codec for the output file. Valid values include <code>aac</code>, <code>mp3</code>, and <code>vorbis</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.AudioParameters.CodecOptions"> <summary> Gets and sets the property CodecOptions. <para> If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> compression profile to use. Valid values include: </para> <para> <code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code> </para> <para> If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.AudioParameters.SampleRate"> <summary> Gets and sets the property SampleRate. <para> The sample rate of the audio stream in the output file, in Hertz. Valid values include: </para> <para> <code>auto</code>, <code>22050</code>, <code>32000</code>, <code>44100</code>, <code>48000</code>, <code>96000</code> </para> <para> If you specify <code>auto</code>, Elastic Transcoder automatically detects the sample rate. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CancelJobRequest"> <summary> Container for the parameters to the CancelJob operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.CancelJobRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CancelJobRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the job that you want to cancel. </para> <para> To get a list of the jobs (including their <code>jobId</code>) that have a status of <code>Submitted</code>, use the <a>ListJobsByStatus</a> API action. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CancelJobResponse"> <summary> Returns information about the CancelJobResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CancelJobResponse.CancelJobResult"> <summary> Gets and sets the CancelJobResult property. Represents the output of a CancelJob operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CancelJobResult"> <summary> The response body contains a JSON object. If the job is successfully canceled, the value of <code>Success</code> is <code>true</code>. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CaptionFormat"> <summary> The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CaptionFormat.WithFormat(System.String)"> <summary> Sets the Format property </summary> <param name="format">The value to set for the Format property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CaptionFormat.WithPattern(System.String)"> <summary> Sets the Pattern property </summary> <param name="pattern">The value to set for the Pattern property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CaptionFormat.Format"> <summary> Gets and sets the property Format. <para> The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output. </para> <ul> <li> <para> <b>Valid Embedded Caption Formats:</b> </para> <ul> <li> <para> <b>For MP3</b>: None </para> </li> <li> <para> <b>For MP4</b>: mov-text </para> </li> <li> <para> <b>For MPEG-TS</b>: None </para> </li> <li> <para> <b>For ogg</b>: None </para> </li> <li> <para> <b>For webm</b>: None </para> </li> </ul> </li> <li> <para> <b>Valid Sidecar Caption Formats:</b> Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. </para> </li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CaptionFormat.Pattern"> <summary> Gets and sets the property Pattern. <para> The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where: </para> <ul> <li><i>description</i> is a description of the video.</li> <li><code>{language}</code> is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.</li> </ul> <para> If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically appends "<code>{language}</code>" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files. </para> <para> For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Captions"> <summary> The captions to be created, if any. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Captions.WithCaptionFormats(Amazon.ElasticTranscoder.Model.CaptionFormat[])"> <summary> Sets the CaptionFormats property </summary> <param name="captionFormats">The values to add to the CaptionFormats collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Captions.WithCaptionFormats(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.CaptionFormat})"> <summary> Sets the CaptionFormats property </summary> <param name="captionFormats">The values to add to the CaptionFormats collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Captions.WithCaptionSources(Amazon.ElasticTranscoder.Model.CaptionSource[])"> <summary> Sets the CaptionSources property </summary> <param name="captionSources">The values to add to the CaptionSources collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Captions.WithCaptionSources(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.CaptionSource})"> <summary> Sets the CaptionSources property </summary> <param name="captionSources">The values to add to the CaptionSources collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Captions.WithMergePolicy(System.String)"> <summary> Sets the MergePolicy property </summary> <param name="mergePolicy">The value to set for the MergePolicy property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Captions.CaptionFormats"> <summary> Gets and sets the property CaptionFormats. <para> The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Captions.CaptionSources"> <summary> Gets and sets the property CaptionSources. <para> Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave <code>CaptionSources</code> blank. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Captions.MergePolicy"> <summary> Gets and sets the property MergePolicy. <para> A policy that determines how Elastic Transcoder handles the existence of multiple captions. </para> <ul> <li> <para> <b>MergeOverride:</b> Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language. </para> </li> <li> <para> <b>MergeRetain:</b> Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If <guilabel>CaptionSources</guilabel> is empty, Elastic Transcoder omits all sidecar captions from the output files. </para> </li> <li> <para> <b>Override:</b> Elastic Transcoder transcodes only the sidecar captions that you specify in <code>CaptionSources</code>. </para> </li> </ul> <para> <code>MergePolicy</code> cannot be null. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CaptionSource"> <summary> A source file for the input sidecar captions used during the transcoding process. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CaptionSource.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CaptionSource.WithLabel(System.String)"> <summary> Sets the Label property </summary> <param name="label">The value to set for the Label property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CaptionSource.WithLanguage(System.String)"> <summary> Sets the Language property </summary> <param name="language">The value to set for the Language property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CaptionSource.WithTimeOffset(System.String)"> <summary> Sets the TimeOffset property </summary> <param name="timeOffset">The value to set for the TimeOffset property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CaptionSource.Key"> <summary> Gets and sets the property Key. <para> The name of the sidecar caption file that you want Elastic Transcoder to include in the output file. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CaptionSource.Label"> <summary> Gets and sets the property Label. <para> The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CaptionSource.Language"> <summary> Gets and sets the property Language. <para> A string that specifies the language of the caption. Specify this as one of: </para> <ul> <li> <para> 2-character ISO 639-1 code </para> </li> <li> <para> 3-character ISO 639-2 code </para> </li> </ul> <para> For more information on ISO language codes and language names, see the List of ISO 639-1 codes. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CaptionSource.TimeOffset"> <summary> Gets and sets the property TimeOffset. <para> For clip generation or captions that do not start at the same time as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode before including captions. </para> <para> Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Clip"> <summary> Settings for one clip in a composition. All jobs in a playlist must have the same clip settings. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Clip.WithTimeSpan(Amazon.ElasticTranscoder.Model.TimeSpan)"> <summary> Sets the TimeSpan property </summary> <param name="timeSpan">The value to set for the TimeSpan property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Clip.TimeSpan"> <summary> Gets and sets the property TimeSpan. <para> Settings that determine when a clip begins and how long it lasts. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreateJobOutput"> <summary> The <code>CreateJobOutput</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithAlbumArt(Amazon.ElasticTranscoder.Model.JobAlbumArt)"> <summary> Sets the AlbumArt property </summary> <param name="albumArt">The value to set for the AlbumArt property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithCaptions(Amazon.ElasticTranscoder.Model.Captions)"> <summary> Sets the Captions property </summary> <param name="captions">The value to set for the Captions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithComposition(Amazon.ElasticTranscoder.Model.Clip[])"> <summary> Sets the Composition property </summary> <param name="composition">The values to add to the Composition collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithComposition(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Clip})"> <summary> Sets the Composition property </summary> <param name="composition">The values to add to the Composition collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithPresetId(System.String)"> <summary> Sets the PresetId property </summary> <param name="presetId">The value to set for the PresetId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithRotate(System.String)"> <summary> Sets the Rotate property </summary> <param name="rotate">The value to set for the Rotate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithSegmentDuration(System.String)"> <summary> Sets the SegmentDuration property </summary> <param name="segmentDuration">The value to set for the SegmentDuration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithThumbnailPattern(System.String)"> <summary> Sets the ThumbnailPattern property </summary> <param name="thumbnailPattern">The value to set for the ThumbnailPattern property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithWatermarks(Amazon.ElasticTranscoder.Model.JobWatermark[])"> <summary> Sets the Watermarks property </summary> <param name="watermarks">The values to add to the Watermarks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobOutput.WithWatermarks(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.JobWatermark})"> <summary> Sets the Watermarks property </summary> <param name="watermarks">The values to add to the Watermarks collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.AlbumArt"> <summary> Gets and sets the property AlbumArt. <para> Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.Captions"> <summary> Gets and sets the property Captions. <para> You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: </para> <ul> <li> <para> <b>Embedded:</b> Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. </para> <para> Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only), <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code> </para> <para> Valid outputs include: <code>mov-text</code> </para> <para> Elastic Transcoder supports a maximum of one embedded format per output. </para> </li> <li> <para> <b>Sidecar:</b> Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. </para> <para> Valid input values include: <code>dfxp</code> (first div element only), <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>, <code>ttml</code> (first div element only), and <code>webvtt</code> </para> <para> Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>, <code>srt</code>, and <code>webvtt</code>. </para> </li> </ul> <para> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. </para> <para> Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. </para> <para> To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>, and pass in a null <code>CaptionSources</code> array. </para> <para> For more information on embedded files, see the Subtitles Wikipedia page. </para> <para> For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.Composition"> <summary> Gets and sets the property Composition. <para> You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.Key"> <summary> Gets and sets the property Key. <para> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the <code>OutputBucket</code> object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.PresetId"> <summary> Gets and sets the property PresetId. <para> The <code>Id</code> of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.Rotate"> <summary> Gets and sets the property Rotate. <para> The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: <code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>, <code>270</code>. The value <code>auto</code> generally works only if the file that you're transcoding contains rotation metadata. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.SegmentDuration"> <summary> Gets and sets the property SegmentDuration. <para> If you specify a preset in <code>PresetId</code> for which the value of <code>Container</code> is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.ThumbnailPattern"> <summary> Gets and sets the property ThumbnailPattern. <para> Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. </para> <para> If you don't want Elastic Transcoder to create thumbnails, specify "". </para> <para> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: </para> <ul> <li> <para> <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you must include <code>{count}</code> in the <code>ThumbnailPattern</code> object. Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence number (beginning with <b>00001</b>) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. </para> <important>If you specify a literal value and/or <code>{resolution}</code> but you omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create the job.</important> </li> <li> <para> <b>Literal values (Optional)</b>: You can specify literal values anywhere in the <code>ThumbnailPattern</code> object. For example, you can include them as a file name prefix or as a delimiter between <code>{resolution}</code> and <code>{count}</code>. </para> </li> <li> <para> <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the resolution in the file name, include <code>{resolution}</code> in the <code>ThumbnailPattern</code> object. </para> </li> </ul> <para> When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the <code>PresetID</code> value of <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name extension. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobOutput.Watermarks"> <summary> Gets and sets the property Watermarks. <para> Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreateJobPlaylist"> <summary> Information about the master playlist. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobPlaylist.WithFormat(System.String)"> <summary> Sets the Format property </summary> <param name="format">The value to set for the Format property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobPlaylist.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobPlaylist.WithOutputKeys(System.String[])"> <summary> Sets the OutputKeys property </summary> <param name="outputKeys">The values to add to the OutputKeys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobPlaylist.WithOutputKeys(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the OutputKeys property </summary> <param name="outputKeys">The values to add to the OutputKeys collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobPlaylist.Format"> <summary> Gets and sets the property Format. <para> This value must currently be HLSv3. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobPlaylist.Name"> <summary> Gets and sets the property Name. <para> The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. The name cannot include a / character. If you create more than one master playlist (not recommended), the values of all <code>Name</code> objects must be unique. Elastic Transcoder automatically appends .m3u8 to the file name. If you include .m3u8 in <code>Name</code>, it will appear twice in the file name. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobPlaylist.OutputKeys"> <summary> Gets and sets the property OutputKeys. <para> For each output in this job that you want to include in a master playlist, the value of the <code>Outputs:Key</code> object. If you include more than one output in a playlist, the value of <code>SegmentDuration</code> for all of the outputs must be the same. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreateJobRequest"> <summary> Container for the parameters to the CreateJob operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithInput(Amazon.ElasticTranscoder.Model.JobInput)"> <summary> Sets the Input property </summary> <param name="input">The value to set for the Input property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithOutput(Amazon.ElasticTranscoder.Model.CreateJobOutput)"> <summary> Sets the Output property </summary> <param name="output">The value to set for the Output property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithOutputKeyPrefix(System.String)"> <summary> Sets the OutputKeyPrefix property </summary> <param name="outputKeyPrefix">The value to set for the OutputKeyPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithOutputs(Amazon.ElasticTranscoder.Model.CreateJobOutput[])"> <summary> Sets the Outputs property </summary> <param name="outputs">The values to add to the Outputs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithOutputs(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.CreateJobOutput})"> <summary> Sets the Outputs property </summary> <param name="outputs">The values to add to the Outputs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithPlaylists(Amazon.ElasticTranscoder.Model.CreateJobPlaylist[])"> <summary> Sets the Playlists property </summary> <param name="playlists">The values to add to the Playlists collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobRequest.WithPlaylists(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.CreateJobPlaylist})"> <summary> Sets the Playlists property </summary> <param name="playlists">The values to add to the Playlists collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobRequest.Input"> <summary> Gets and sets the property Input. <para> A section of the request body that provides information about the file that is being transcoded. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobRequest.Output"> <summary> Gets and sets the property Output. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobRequest.OutputKeyPrefix"> <summary> Gets and sets the property OutputKeyPrefix. <para> The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobRequest.Outputs"> <summary> Gets and sets the property Outputs. <para> A section of the request body that provides information about the transcoded (target) files. We recommend that you use the <code>Outputs</code> syntax instead of the <code>Output</code> syntax. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The <code>Id</code> of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobRequest.Playlists"> <summary> Gets and sets the property Playlists. <para> If you specify a preset in <code>PresetId</code> for which the value of <code>Container</code> is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. </para> <para> We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreateJobResponse"> <summary> Returns information about the CreateJobResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobResponse.CreateJobResult"> <summary> Gets and sets the CreateJobResult property. Represents the output of a CreateJob operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreateJobResult"> <summary> The CreateJobResponse structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreateJobResult.WithJob(Amazon.ElasticTranscoder.Model.Job)"> <summary> Sets the Job property </summary> <param name="job">The value to set for the Job property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreateJobResult.Job"> <summary> Gets and sets the property Job. <para> A section of the response body that provides information about the job that is created. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreatePipelineRequest"> <summary> Container for the parameters to the CreatePipeline operation. The CreatePipeline operation creates a pipeline with settings that you specify. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.WithContentConfig(Amazon.ElasticTranscoder.Model.PipelineOutputConfig)"> <summary> Sets the ContentConfig property </summary> <param name="contentConfig">The value to set for the ContentConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.WithInputBucket(System.String)"> <summary> Sets the InputBucket property </summary> <param name="inputBucket">The value to set for the InputBucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.WithNotifications(Amazon.ElasticTranscoder.Model.Notifications)"> <summary> Sets the Notifications property </summary> <param name="notifications">The value to set for the Notifications property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.WithOutputBucket(System.String)"> <summary> Sets the OutputBucket property </summary> <param name="outputBucket">The value to set for the OutputBucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.WithRole(System.String)"> <summary> Sets the Role property </summary> <param name="role">The value to set for the Role property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.WithThumbnailConfig(Amazon.ElasticTranscoder.Model.PipelineOutputConfig)"> <summary> Sets the ThumbnailConfig property </summary> <param name="thumbnailConfig">The value to set for the ThumbnailConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.ContentConfig"> <summary> Gets and sets the property ContentConfig. <para> The optional <code>ContentConfig</code> object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. </para> <para> If you specify values for <code>ContentConfig</code>, you must also specify values for <code>ThumbnailConfig</code>. </para> <para> If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>, omit the <code>OutputBucket</code> object. </para> <ul> <li><b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.</li> <li><b>Permissions</b> (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</li> <li><b>Grantee Type</b>: Specify the type of value that appears in the <code>Grantee</code> object: <ul> <li><b>Canonical</b>: The value in the <code>Grantee</code> object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. <important>A canonical user ID is not the same as an AWS account number.</important> </li> <li><b>Email</b>: The value in the <code>Grantee</code> object is the registered email address of an AWS account.</li> <li><b>Group</b>: The value in the <code>Grantee</code> object is one of the following predefined Amazon S3 groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li> </ul> </li> <li> <b>Grantee</b>: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group </li> <li> <b>Access</b>: The permission that you want to give to the AWS user that you specified in <code>Grantee</code>. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: <ul> <li><code>READ</code>: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>READ_ACP</code>: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. </li> <li><code>WRITE_ACP</code>: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>FULL_CONTROL</code>: The grantee has <code>READ</code>, <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> </ul> </li> <li> <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.InputBucket"> <summary> Gets and sets the property InputBucket. <para> The Amazon S3 bucket in which you saved the media files that you want to transcode. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. </para> <para> Constraints: Maximum 40 characters. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.Notifications"> <summary> Gets and sets the property Notifications. <para> The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. </para> <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.</important> <ul> <li><b>Progressing</b>: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.</li> <li><b>Completed</b>: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.</li> <li><b>Warning</b>: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.</li> <li><b>Error</b>: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.OutputBucket"> <summary> Gets and sets the property OutputBucket. <para> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.) </para> <para> Specify this value when all of the following are true: <ul> <li>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</li> <li>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</li> <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. <important>When Elastic Transcoder saves files in <code>OutputBucket</code>, it grants full control over the files only to the AWS account that owns the role that is specified by <code>Role</code>.</important></li> <li>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</li> </ul> </para> <para> If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit <code>OutputBucket</code> and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.Role"> <summary> Gets and sets the property Role. <para> The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineRequest.ThumbnailConfig"> <summary> Gets and sets the property ThumbnailConfig. <para> The <code>ThumbnailConfig</code> object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. </para> <para> If you specify values for <code>ContentConfig</code>, you must also specify values for <code>ThumbnailConfig</code> even if you don't want to create thumbnails. </para> <para> If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>, omit the <code>OutputBucket</code> object. </para> <ul> <li><b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.</li> <li><b>Permissions</b> (Optional): The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</li> <li> <b>GranteeType</b>: Specify the type of value that appears in the Grantee object: <ul> <li> <b>Canonical</b>: The value in the <code>Grantee</code> object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. <important>A canonical user ID is not the same as an AWS account number.</important></li> <li><b>Email</b>: The value in the <code>Grantee</code> object is the registered email address of an AWS account. </li> <li><b>Group</b>: The value in the <code>Grantee</code> object is one of the following predefined Amazon S3 groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li> </ul> </li> <li> <b>Grantee</b>: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. </li> <li> <b>Access</b>: The permission that you want to give to the AWS user that you specified in <code>Grantee</code>. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: <ul> <li><code>READ</code>: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. </li> <li><code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>FULL_CONTROL</code>: The grantee has <code>READ</code>, <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. </li> </ul> </li> <li> <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.</li> </ul> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreatePipelineResponse"> <summary> Returns information about the CreatePipelineResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineResponse.CreatePipelineResult"> <summary> Gets and sets the CreatePipelineResult property. Represents the output of a CreatePipeline operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreatePipelineResult"> <summary> When you create a pipeline, Elastic Transcoder returns the values that you specified in the request. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePipelineResult.WithPipeline(Amazon.ElasticTranscoder.Model.Pipeline)"> <summary> Sets the Pipeline property </summary> <param name="pipeline">The value to set for the Pipeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePipelineResult.Pipeline"> <summary> Gets and sets the property Pipeline. <para> A section of the response body that provides information about the pipeline that is created. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreatePresetRequest"> <summary> Container for the parameters to the CreatePreset operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetRequest.WithAudio(Amazon.ElasticTranscoder.Model.AudioParameters)"> <summary> Sets the Audio property </summary> <param name="audio">The value to set for the Audio property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetRequest.WithContainer(System.String)"> <summary> Sets the Container property </summary> <param name="container">The value to set for the Container property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetRequest.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetRequest.WithThumbnails(Amazon.ElasticTranscoder.Model.Thumbnails)"> <summary> Sets the Thumbnails property </summary> <param name="thumbnails">The value to set for the Thumbnails property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetRequest.WithVideo(Amazon.ElasticTranscoder.Model.VideoParameters)"> <summary> Sets the Video property </summary> <param name="video">The value to set for the Video property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetRequest.Audio"> <summary> Gets and sets the property Audio. <para> A section of the request body that specifies the audio parameters. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetRequest.Container"> <summary> Gets and sets the property Container. <para> The container type for the output file. Valid values include <code>mp3</code>, <code>mp4</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetRequest.Description"> <summary> Gets and sets the property Description. <para> A description of the preset. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetRequest.Thumbnails"> <summary> Gets and sets the property Thumbnails. <para> A section of the request body that specifies the thumbnail parameters, if any. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetRequest.Video"> <summary> Gets and sets the property Video. <para> A section of the request body that specifies the video parameters. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreatePresetResponse"> <summary> Returns information about the CreatePresetResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetResponse.CreatePresetResult"> <summary> Gets and sets the CreatePresetResult property. Represents the output of a CreatePreset operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.CreatePresetResult"> <summary> The <code>CreatePresetResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetResult.WithPreset(Amazon.ElasticTranscoder.Model.Preset)"> <summary> Sets the Preset property </summary> <param name="preset">The value to set for the Preset property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.CreatePresetResult.WithWarning(System.String)"> <summary> Sets the Warning property </summary> <param name="warning">The value to set for the Warning property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetResult.Preset"> <summary> Gets and sets the property Preset. <para> A section of the response body that provides information about the preset that is created. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.CreatePresetResult.Warning"> <summary> Gets and sets the property Warning. <para> If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.DeletePipelineRequest"> <summary> Container for the parameters to the DeletePipeline operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.DeletePipelineRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.DeletePipelineRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the pipeline that you want to delete. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.DeletePipelineResponse"> <summary> Returns information about the DeletePipelineResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.DeletePipelineResponse.DeletePipelineResult"> <summary> Gets and sets the DeletePipelineResult property. Represents the output of a DeletePipeline operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.DeletePipelineResult"> <summary> The <code>DeletePipelineResponse</code> structure. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.DeletePresetRequest"> <summary> Container for the parameters to the DeletePreset operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.DeletePresetRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.DeletePresetRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the preset for which you want to get detailed information. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.DeletePresetResponse"> <summary> Returns information about the DeletePresetResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.DeletePresetResponse.DeletePresetResult"> <summary> Gets and sets the DeletePresetResult property. Represents the output of a DeletePreset operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.DeletePresetResult"> <summary> The <code>DeletePresetResponse</code> structure. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.IncompatibleVersionException"> <summary> ElasticTranscoder exception </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.IncompatibleVersionException.#ctor(System.String)"> <summary> Constructs a new IncompatibleVersionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticTranscoder.Model.InternalServiceException"> <summary> ElasticTranscoder exception </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.InternalServiceException.#ctor(System.String)"> <summary> Constructs a new InternalServiceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ArtworkUnmarshaller"> <summary> Response Unmarshaller for Artwork Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.AudioCodecOptionsUnmarshaller"> <summary> Response Unmarshaller for AudioCodecOptions Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.AudioParametersUnmarshaller"> <summary> Response Unmarshaller for AudioParameters Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CancelJobRequestMarshaller"> <summary> CancelJob Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CancelJobResponseUnmarshaller"> <summary> Response Unmarshaller for CancelJob operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CancelJobResultUnmarshaller"> <summary> Response Unmarshaller for CancelJob Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CaptionFormatUnmarshaller"> <summary> Response Unmarshaller for CaptionFormat Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CaptionSourceUnmarshaller"> <summary> Response Unmarshaller for CaptionSource Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CaptionsUnmarshaller"> <summary> Response Unmarshaller for Captions Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ClipUnmarshaller"> <summary> Response Unmarshaller for Clip Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreateJobRequestMarshaller"> <summary> CreateJob Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreateJobResponseUnmarshaller"> <summary> Response Unmarshaller for CreateJob operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreateJobResultUnmarshaller"> <summary> Response Unmarshaller for CreateJob Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreatePipelineRequestMarshaller"> <summary> CreatePipeline Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreatePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePipeline operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreatePipelineResultUnmarshaller"> <summary> Response Unmarshaller for CreatePipeline Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreatePresetRequestMarshaller"> <summary> CreatePreset Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreatePresetResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePreset operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.CreatePresetResultUnmarshaller"> <summary> Response Unmarshaller for CreatePreset Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.DeletePipelineRequestMarshaller"> <summary> DeletePipeline Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.DeletePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for DeletePipeline operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.DeletePipelineResultUnmarshaller"> <summary> Response Unmarshaller for DeletePipeline Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.DeletePresetRequestMarshaller"> <summary> DeletePreset Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.DeletePresetResponseUnmarshaller"> <summary> Response Unmarshaller for DeletePreset operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.DeletePresetResultUnmarshaller"> <summary> Response Unmarshaller for DeletePreset Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.JobAlbumArtUnmarshaller"> <summary> Response Unmarshaller for JobAlbumArt Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.JobInputUnmarshaller"> <summary> Response Unmarshaller for JobInput Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.JobOutputUnmarshaller"> <summary> Response Unmarshaller for JobOutput Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.JobUnmarshaller"> <summary> Response Unmarshaller for Job Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.JobWatermarkUnmarshaller"> <summary> Response Unmarshaller for JobWatermark Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListJobsByPipelineRequestMarshaller"> <summary> ListJobsByPipeline Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListJobsByPipelineResponseUnmarshaller"> <summary> Response Unmarshaller for ListJobsByPipeline operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListJobsByPipelineResultUnmarshaller"> <summary> Response Unmarshaller for ListJobsByPipeline Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListJobsByStatusRequestMarshaller"> <summary> ListJobsByStatus Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListJobsByStatusResponseUnmarshaller"> <summary> Response Unmarshaller for ListJobsByStatus operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListJobsByStatusResultUnmarshaller"> <summary> Response Unmarshaller for ListJobsByStatus Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListPipelinesRequestMarshaller"> <summary> ListPipelines Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListPipelinesResponseUnmarshaller"> <summary> Response Unmarshaller for ListPipelines operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListPipelinesResultUnmarshaller"> <summary> Response Unmarshaller for ListPipelines Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListPresetsRequestMarshaller"> <summary> ListPresets Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListPresetsResponseUnmarshaller"> <summary> Response Unmarshaller for ListPresets operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ListPresetsResultUnmarshaller"> <summary> Response Unmarshaller for ListPresets Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.NotificationsUnmarshaller"> <summary> Response Unmarshaller for Notifications Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.PermissionUnmarshaller"> <summary> Response Unmarshaller for Permission Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.PipelineOutputConfigUnmarshaller"> <summary> Response Unmarshaller for PipelineOutputConfig Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.PipelineUnmarshaller"> <summary> Response Unmarshaller for Pipeline Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.PlaylistUnmarshaller"> <summary> Response Unmarshaller for Playlist Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.PresetUnmarshaller"> <summary> Response Unmarshaller for Preset Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.PresetWatermarkUnmarshaller"> <summary> Response Unmarshaller for PresetWatermark Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadJobRequestMarshaller"> <summary> ReadJob Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadJobResponseUnmarshaller"> <summary> Response Unmarshaller for ReadJob operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadJobResultUnmarshaller"> <summary> Response Unmarshaller for ReadJob Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadPipelineRequestMarshaller"> <summary> ReadPipeline Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadPipelineResponseUnmarshaller"> <summary> Response Unmarshaller for ReadPipeline operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadPipelineResultUnmarshaller"> <summary> Response Unmarshaller for ReadPipeline Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadPresetRequestMarshaller"> <summary> ReadPreset Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadPresetResponseUnmarshaller"> <summary> Response Unmarshaller for ReadPreset operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ReadPresetResultUnmarshaller"> <summary> Response Unmarshaller for ReadPreset Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.TestRoleRequestMarshaller"> <summary> TestRole Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.TestRoleResponseUnmarshaller"> <summary> Response Unmarshaller for TestRole operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.TestRoleResultUnmarshaller"> <summary> Response Unmarshaller for TestRole Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.ThumbnailsUnmarshaller"> <summary> Response Unmarshaller for Thumbnails Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.TimeSpanUnmarshaller"> <summary> Response Unmarshaller for TimeSpan Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineNotificationsRequestMarshaller"> <summary> UpdatePipelineNotifications Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineNotificationsResponseUnmarshaller"> <summary> Response Unmarshaller for UpdatePipelineNotifications operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineNotificationsResultUnmarshaller"> <summary> Response Unmarshaller for UpdatePipelineNotifications Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineRequestMarshaller"> <summary> UpdatePipeline Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for UpdatePipeline operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineResultUnmarshaller"> <summary> Response Unmarshaller for UpdatePipeline Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineStatusRequestMarshaller"> <summary> UpdatePipelineStatus Request Marshaller </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineStatusResponseUnmarshaller"> <summary> Response Unmarshaller for UpdatePipelineStatus operation </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.UpdatePipelineStatusResultUnmarshaller"> <summary> Response Unmarshaller for UpdatePipelineStatus Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Internal.MarshallTransformations.VideoParametersUnmarshaller"> <summary> Response Unmarshaller for VideoParameters Object </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Job"> <summary> A section of the response body that provides information about the job that is created. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithArn(System.String)"> <summary> Sets the Arn property </summary> <param name="arn">The value to set for the Arn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithInput(Amazon.ElasticTranscoder.Model.JobInput)"> <summary> Sets the Input property </summary> <param name="input">The value to set for the Input property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithOutput(Amazon.ElasticTranscoder.Model.JobOutput)"> <summary> Sets the Output property </summary> <param name="output">The value to set for the Output property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithOutputKeyPrefix(System.String)"> <summary> Sets the OutputKeyPrefix property </summary> <param name="outputKeyPrefix">The value to set for the OutputKeyPrefix property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithOutputs(Amazon.ElasticTranscoder.Model.JobOutput[])"> <summary> Sets the Outputs property </summary> <param name="outputs">The values to add to the Outputs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithOutputs(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.JobOutput})"> <summary> Sets the Outputs property </summary> <param name="outputs">The values to add to the Outputs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithPlaylists(Amazon.ElasticTranscoder.Model.Playlist[])"> <summary> Sets the Playlists property </summary> <param name="playlists">The values to add to the Playlists collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithPlaylists(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Playlist})"> <summary> Sets the Playlists property </summary> <param name="playlists">The values to add to the Playlists collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Job.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) for the job. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.Id"> <summary> Gets and sets the property Id. <para> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.Input"> <summary> Gets and sets the property Input. <para> A section of the request or response body that provides information about the file that is being transcoded. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.Output"> <summary> Gets and sets the property Output. <para> If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object. </para> <para> <important>Outputs recommended instead.</important> A section of the request or response body that provides information about the transcoded (target) file. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.OutputKeyPrefix"> <summary> Gets and sets the property OutputKeyPrefix. <para> The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the <code>OutputKeyPrefix</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.Outputs"> <summary> Gets and sets the property Outputs. <para> Information about the output files. We recommend that you use the <code>Outputs</code> syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the <code>Outputs</code> and <code>Output</code> syntaxes in the same request. You can create a maximum of 30 outputs per job. </para> <para> If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The <code>Id</code> of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.Playlists"> <summary> Gets and sets the property Playlists. <para> <important>Outputs in MPEG-TS format only.</important>If you specify a preset in <code>PresetId</code> for which the value of <code>Container</code> is ts (MPEG-TS), <code>Playlists</code> contains information about the master playlists that you want Elastic Transcoder to create. </para> <para> We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Job.Status"> <summary> Gets and sets the property Status. <para> The status of the job: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or <code>Error</code>. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.JobAlbumArt"> <summary> The .jpg or .png file associated with an audio file. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobAlbumArt.WithArtwork(Amazon.ElasticTranscoder.Model.Artwork[])"> <summary> Sets the Artwork property </summary> <param name="artwork">The values to add to the Artwork collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobAlbumArt.WithArtwork(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Artwork})"> <summary> Sets the Artwork property </summary> <param name="artwork">The values to add to the Artwork collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobAlbumArt.WithMergePolicy(System.String)"> <summary> Sets the MergePolicy property </summary> <param name="mergePolicy">The value to set for the MergePolicy property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobAlbumArt.Artwork"> <summary> Gets and sets the property Artwork. <para> The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are <code>.jpg</code> and <code>.png</code> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobAlbumArt.MergePolicy"> <summary> Gets and sets the property MergePolicy. <para> A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files. </para> <para> <ul> <li><code>Replace:</code> The specified album art will replace any existing album art.</li> <li><code>Prepend:</code> The specified album art will be placed in front of any existing album art.</li> <li><code>Append:</code> The specified album art will be placed after any existing album art.</li> <li><code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the specified album art file.</li> </ul> </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.JobInput"> <summary> Information about the file that you're transcoding. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobInput.WithAspectRatio(System.String)"> <summary> Sets the AspectRatio property </summary> <param name="aspectRatio">The value to set for the AspectRatio property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobInput.WithContainer(System.String)"> <summary> Sets the Container property </summary> <param name="container">The value to set for the Container property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobInput.WithFrameRate(System.String)"> <summary> Sets the FrameRate property </summary> <param name="frameRate">The value to set for the FrameRate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobInput.WithInterlaced(System.String)"> <summary> Sets the Interlaced property </summary> <param name="interlaced">The value to set for the Interlaced property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobInput.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobInput.WithResolution(System.String)"> <summary> Sets the Resolution property </summary> <param name="resolution">The value to set for the Resolution property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobInput.AspectRatio"> <summary> Gets and sets the property AspectRatio. <para> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify <code>auto</code>. If you want to specify the aspect ratio for the output file, enter one of the following values: </para> <para> <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code> </para> <para> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of the aspect ratio. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobInput.Container"> <summary> Gets and sets the property Container. <para> The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify <code>auto</code>. If you want to specify the container type for the input file, enter one of the following values: </para> <para> <code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, <code>divx</code>, <code>flv</code>, <code>m4a</code>, <code>mkv</code>, <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>, <code>ogg</code>, <code>vob</code>, <code>wav</code>, <code>webm</code> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobInput.FrameRate"> <summary> Gets and sets the property FrameRate. <para> The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify <code>auto</code>. If you want to specify the frame rate for the input file, enter one of the following values: </para> <para> <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code> </para> <para> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of the frame rate. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobInput.Interlaced"> <summary> Gets and sets the property Interlaced. <para> Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify <code>auto</code>. If you want to specify whether the input file is interlaced, enter one of the following values: </para> <para> <code>true</code>, <code>false</code> </para> <para> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of interlacing. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobInput.Key"> <summary> Gets and sets the property Key. <para> The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The <code>InputBucket</code> object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </para> <para> If the file name includes a prefix, such as <code>cooking/lasagna.mpg</code>, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobInput.Resolution"> <summary> Gets and sets the property Resolution. <para> This value must be <code>auto</code>, which causes Elastic Transcoder to automatically detect the resolution of the input file. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.JobOutput"> <summary> <important>Outputs recommended instead.</important>If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the <code>Output</code> object lists information about the first output. This duplicates the information that is listed for the first output in the <code>Outputs</code> object. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithAlbumArt(Amazon.ElasticTranscoder.Model.JobAlbumArt)"> <summary> Sets the AlbumArt property </summary> <param name="albumArt">The value to set for the AlbumArt property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithCaptions(Amazon.ElasticTranscoder.Model.Captions)"> <summary> Sets the Captions property </summary> <param name="captions">The value to set for the Captions property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithComposition(Amazon.ElasticTranscoder.Model.Clip[])"> <summary> Sets the Composition property </summary> <param name="composition">The values to add to the Composition collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithComposition(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Clip})"> <summary> Sets the Composition property </summary> <param name="composition">The values to add to the Composition collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithDuration(System.Int64)"> <summary> Sets the Duration property </summary> <param name="duration">The value to set for the Duration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithHeight(System.Int32)"> <summary> Sets the Height property </summary> <param name="height">The value to set for the Height property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithKey(System.String)"> <summary> Sets the Key property </summary> <param name="key">The value to set for the Key property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithPresetId(System.String)"> <summary> Sets the PresetId property </summary> <param name="presetId">The value to set for the PresetId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithRotate(System.String)"> <summary> Sets the Rotate property </summary> <param name="rotate">The value to set for the Rotate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithSegmentDuration(System.String)"> <summary> Sets the SegmentDuration property </summary> <param name="segmentDuration">The value to set for the SegmentDuration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithStatusDetail(System.String)"> <summary> Sets the StatusDetail property </summary> <param name="statusDetail">The value to set for the StatusDetail property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithThumbnailPattern(System.String)"> <summary> Sets the ThumbnailPattern property </summary> <param name="thumbnailPattern">The value to set for the ThumbnailPattern property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithWatermarks(Amazon.ElasticTranscoder.Model.JobWatermark[])"> <summary> Sets the Watermarks property </summary> <param name="watermarks">The values to add to the Watermarks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithWatermarks(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.JobWatermark})"> <summary> Sets the Watermarks property </summary> <param name="watermarks">The values to add to the Watermarks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobOutput.WithWidth(System.Int32)"> <summary> Sets the Width property </summary> <param name="width">The value to set for the Width property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.AlbumArt"> <summary> Gets and sets the property AlbumArt. <para> The album art to be associated with the output file, if any. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Captions"> <summary> Gets and sets the property Captions. <para> You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions: </para> <ul> <li> <para> <b>Embedded:</b> Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file. </para> <para> Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only), <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code> </para> <para> Valid outputs include: <code>mov-text</code> </para> <para> Elastic Transcoder supports a maximum of one embedded format per output. </para> </li> <li> <para> <b>Sidecar:</b> Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file. </para> <para> Valid input values include: <code>dfxp</code> (first div element only), <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>, <code>ttml</code> (first div element only), and <code>webvtt</code> </para> <para> Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>, <code>srt</code>, and <code>webvtt</code>. </para> </li> </ul> <para> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format. </para> <para> Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process. </para> <para> To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>, and pass in a null <code>CaptionSources</code> array. </para> <para> For more information on embedded files, see the Subtitles Wikipedia page. </para> <para> For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Composition"> <summary> Gets and sets the property Composition. <para> You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Duration"> <summary> Gets and sets the property Duration. <para> Duration of the output file, in seconds. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Height"> <summary> Gets and sets the property Height. <para> Height of the output file, in pixels. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Id"> <summary> Gets and sets the property Id. <para> A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Key"> <summary> Gets and sets the property Key. <para> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the <code>OutputBucket</code> object in the pipeline that is specified by the pipeline ID. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.PresetId"> <summary> Gets and sets the property PresetId. <para> The value of the <code>Id</code> object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with <code>ListPresets</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Rotate"> <summary> Gets and sets the property Rotate. <para> The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: </para> <para> <code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>, <code>270</code> </para> <para> The value <code>auto</code> generally works only if the file that you're transcoding contains rotation metadata. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.SegmentDuration"> <summary> Gets and sets the property SegmentDuration. <para> <important>(Outputs in MPEG-TS format only.</important>If you specify a preset in <code>PresetId</code> for which the value of <code>Container</code>is <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder creates an output-specific playlist for each output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in <code>OutputKeys</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Status"> <summary> Gets and sets the property Status. <para> The status of one output in a job. If you specified only one output for the job, <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you specified more than one output: <ul> <li><code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs is Submitted until Elastic Transcoder starts to process the first output.</li> <li>When Elastic Transcoder starts to process the first output, <code>Outputs:Status</code> for that output and <code>Job:Status</code> both change to Progressing. For each output, the value of <code>Outputs:Status</code> remains Submitted until Elastic Transcoder starts to process the output.</li> <li>Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.</li> <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes to Complete only if <code>Outputs:Status</code> for all of the outputs is <code>Complete</code>. If <code>Outputs:Status</code> for one or more outputs is <code>Error</code>, the terminal status for <code>Job:Status</code> is also <code>Error</code>.</li> </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or <code>Error</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.StatusDetail"> <summary> Gets and sets the property StatusDetail. <para> Information that further explains <code>Status</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.ThumbnailPattern"> <summary> Gets and sets the property ThumbnailPattern. <para> Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. </para> <para> If you don't want Elastic Transcoder to create thumbnails, specify "". </para> <para> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence: </para> <ul> <li> <para> <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you must include <code>{count}</code> in the <code>ThumbnailPattern</code> object. Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence number (beginning with <b>00001</b>) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. </para> <important>If you specify a literal value and/or <code>{resolution}</code> but you omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create the job.</important> </li> <li> <para> <b>Literal values (Optional)</b>: You can specify literal values anywhere in the <code>ThumbnailPattern</code> object. For example, you can include them as a file name prefix or as a delimiter between <code>{resolution}</code> and <code>{count}</code>. </para> </li> <li> <para> <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the resolution in the file name, include <code>{resolution}</code> in the <code>ThumbnailPattern</code> object. </para> </li> </ul> <para> When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the <code>PresetID</code> value of <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name extension. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Watermarks"> <summary> Gets and sets the property Watermarks. <para> Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in <code>Preset</code> for the current output. </para> <para> Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobOutput.Width"> <summary> Gets and sets the property Width. <para> Specifies the width of the output file in pixels. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.JobWatermark"> <summary> Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobWatermark.WithInputKey(System.String)"> <summary> Sets the InputKey property </summary> <param name="inputKey">The value to set for the InputKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.JobWatermark.WithPresetWatermarkId(System.String)"> <summary> Sets the PresetWatermarkId property </summary> <param name="presetWatermarkId">The value to set for the PresetWatermarkId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobWatermark.InputKey"> <summary> Gets and sets the property InputKey. <para> The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline identifies the bucket. </para> <para> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.JobWatermark.PresetWatermarkId"> <summary> Gets and sets the property PresetWatermarkId. <para> The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.LimitExceededException"> <summary> ElasticTranscoder exception </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest"> <summary> Container for the parameters to the ListJobsByPipeline operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest.WithAscending(System.String)"> <summary> Sets the Ascending property </summary> <param name="ascending">The value to set for the Ascending property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest.WithPageToken(System.String)"> <summary> Sets the PageToken property </summary> <param name="pageToken">The value to set for the PageToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest.WithPipelineId(System.String)"> <summary> Sets the PipelineId property </summary> <param name="pipelineId">The value to set for the PipelineId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest.Ascending"> <summary> Gets and sets the property Ascending. <para> To list jobs in chronological order by the date and time that they were submitted, enter <code>true</code>. To list jobs in reverse chronological order, enter <code>false</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest.PageToken"> <summary> Gets and sets the property PageToken. <para> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByPipelineRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline for which you want to get job information. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResponse"> <summary> Returns information about the ListJobsByPipelineResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResponse.ListJobsByPipelineResult"> <summary> Gets and sets the ListJobsByPipelineResult property. Represents the output of a ListJobsByPipeline operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResult"> <summary> The <code>ListJobsByPipelineResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResult.WithJobs(Amazon.ElasticTranscoder.Model.Job[])"> <summary> Sets the Jobs property </summary> <param name="jobs">The values to add to the Jobs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResult.WithJobs(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Job})"> <summary> Sets the Jobs property </summary> <param name="jobs">The values to add to the Jobs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResult.WithNextPageToken(System.String)"> <summary> Sets the NextPageToken property </summary> <param name="nextPageToken">The value to set for the NextPageToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResult.Jobs"> <summary> Gets and sets the property Jobs. <para> An array of <code>Job</code> objects that are in the specified pipeline. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByPipelineResult.NextPageToken"> <summary> Gets and sets the property NextPageToken. <para> A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of <code>NextPageToken</code> is <code>null</code>. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest"> <summary> Container for the parameters to the ListJobsByStatus operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest.WithAscending(System.String)"> <summary> Sets the Ascending property </summary> <param name="ascending">The value to set for the Ascending property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest.WithPageToken(System.String)"> <summary> Sets the PageToken property </summary> <param name="pageToken">The value to set for the PageToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest.Ascending"> <summary> Gets and sets the property Ascending. <para> To list jobs in chronological order by the date and time that they were submitted, enter <code>true</code>. To list jobs in reverse chronological order, enter <code>false</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest.PageToken"> <summary> Gets and sets the property PageToken. <para> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByStatusRequest.Status"> <summary> Gets and sets the property Status. <para> To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or <code>Error</code>. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListJobsByStatusResponse"> <summary> Returns information about the ListJobsByStatusResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByStatusResponse.ListJobsByStatusResult"> <summary> Gets and sets the ListJobsByStatusResult property. Represents the output of a ListJobsByStatus operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListJobsByStatusResult"> <summary> The <code>ListJobsByStatusResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByStatusResult.WithJobs(Amazon.ElasticTranscoder.Model.Job[])"> <summary> Sets the Jobs property </summary> <param name="jobs">The values to add to the Jobs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByStatusResult.WithJobs(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Job})"> <summary> Sets the Jobs property </summary> <param name="jobs">The values to add to the Jobs collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListJobsByStatusResult.WithNextPageToken(System.String)"> <summary> Sets the NextPageToken property </summary> <param name="nextPageToken">The value to set for the NextPageToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByStatusResult.Jobs"> <summary> Gets and sets the property Jobs. <para> An array of <code>Job</code> objects that have the specified status. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListJobsByStatusResult.NextPageToken"> <summary> Gets and sets the property NextPageToken. <para> A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of <code>NextPageToken</code> is <code>null</code>. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListPipelinesRequest"> <summary> Container for the parameters to the ListPipelines operation. The ListPipelines operation gets a list of the pipelines associated with the current AWS account. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPipelinesRequest.WithAscending(System.String)"> <summary> Sets the Ascending property </summary> <param name="ascending">The value to set for the Ascending property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPipelinesRequest.WithPageToken(System.String)"> <summary> Sets the PageToken property </summary> <param name="pageToken">The value to set for the PageToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPipelinesRequest.Ascending"> <summary> Gets and sets the property Ascending. <para> To list pipelines in chronological order by the date and time that they were created, enter <code>true</code>. To list pipelines in reverse chronological order, enter <code>false</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPipelinesRequest.PageToken"> <summary> Gets and sets the property PageToken. <para> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListPipelinesResponse"> <summary> Returns information about the ListPipelinesResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPipelinesResponse.ListPipelinesResult"> <summary> Gets and sets the ListPipelinesResult property. Represents the output of a ListPipelines operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListPipelinesResult"> <summary> A list of the pipelines associated with the current AWS account. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPipelinesResult.WithNextPageToken(System.String)"> <summary> Sets the NextPageToken property </summary> <param name="nextPageToken">The value to set for the NextPageToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPipelinesResult.WithPipelines(Amazon.ElasticTranscoder.Model.Pipeline[])"> <summary> Sets the Pipelines property </summary> <param name="pipelines">The values to add to the Pipelines collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPipelinesResult.WithPipelines(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Pipeline})"> <summary> Sets the Pipelines property </summary> <param name="pipelines">The values to add to the Pipelines collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPipelinesResult.NextPageToken"> <summary> Gets and sets the property NextPageToken. <para> A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of <code>NextPageToken</code> is <code>null</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPipelinesResult.Pipelines"> <summary> Gets and sets the property Pipelines. <para> An array of <code>Pipeline</code> objects. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListPresetsRequest"> <summary> Container for the parameters to the ListPresets operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPresetsRequest.WithAscending(System.String)"> <summary> Sets the Ascending property </summary> <param name="ascending">The value to set for the Ascending property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPresetsRequest.WithPageToken(System.String)"> <summary> Sets the PageToken property </summary> <param name="pageToken">The value to set for the PageToken property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPresetsRequest.Ascending"> <summary> Gets and sets the property Ascending. <para> To list presets in chronological order by the date and time that they were created, enter <code>true</code>. To list presets in reverse chronological order, enter <code>false</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPresetsRequest.PageToken"> <summary> Gets and sets the property PageToken. <para> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListPresetsResponse"> <summary> Returns information about the ListPresetsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPresetsResponse.ListPresetsResult"> <summary> Gets and sets the ListPresetsResult property. Represents the output of a ListPresets operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ListPresetsResult"> <summary> The <code>ListPresetsResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPresetsResult.WithNextPageToken(System.String)"> <summary> Sets the NextPageToken property </summary> <param name="nextPageToken">The value to set for the NextPageToken property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPresetsResult.WithPresets(Amazon.ElasticTranscoder.Model.Preset[])"> <summary> Sets the Presets property </summary> <param name="presets">The values to add to the Presets collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.ListPresetsResult.WithPresets(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Preset})"> <summary> Sets the Presets property </summary> <param name="presets">The values to add to the Presets collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPresetsResult.NextPageToken"> <summary> Gets and sets the property NextPageToken. <para> A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of <code>NextPageToken</code> is <code>null</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ListPresetsResult.Presets"> <summary> Gets and sets the property Presets. <para> An array of <code>Preset</code> objects. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Notifications"> <summary> The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status. <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.</important> </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Notifications.WithCompleted(System.String)"> <summary> Sets the Completed property </summary> <param name="completed">The value to set for the Completed property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Notifications.WithError(System.String)"> <summary> Sets the Error property </summary> <param name="error">The value to set for the Error property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Notifications.WithProgressing(System.String)"> <summary> Sets the Progressing property </summary> <param name="progressing">The value to set for the Progressing property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Notifications.WithWarning(System.String)"> <summary> Sets the Warning property </summary> <param name="warning">The value to set for the Warning property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Notifications.Completed"> <summary> Gets and sets the property Completed. <para> The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Notifications.Error"> <summary> Gets and sets the property Error. <para> The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Notifications.Progressing"> <summary> Gets and sets the property Progressing. <para> The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Notifications.Warning"> <summary> Gets and sets the property Warning. <para> The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Permission"> <summary> The <code>Permission</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Permission.WithAccess(System.String[])"> <summary> Sets the Access property </summary> <param name="access">The values to add to the Access collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Permission.WithAccess(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Access property </summary> <param name="access">The values to add to the Access collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Permission.WithGrantee(System.String)"> <summary> Sets the Grantee property </summary> <param name="grantee">The value to set for the Grantee property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Permission.WithGranteeType(System.String)"> <summary> Sets the GranteeType property </summary> <param name="granteeType">The value to set for the GranteeType property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Permission.Access"> <summary> Gets and sets the property Access. <para> The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: <ul> <li><code>READ</code>: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> </ul> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Permission.Grantee"> <summary> Gets and sets the property Grantee. <para> The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Permission.GranteeType"> <summary> Gets and sets the property GranteeType. <para> The type of value that appears in the Grantee object: <ul> <li><code>Canonical</code>: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. <important>A canonical user ID is not the same as an AWS account number.</important></li> <li><code>Email</code>: The registered email address of an AWS account.</li> <li><code>Group</code>: One of the following predefined Amazon S3 groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li> </ul> </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Pipeline"> <summary> The pipeline (queue) that is used to manage jobs. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithArn(System.String)"> <summary> Sets the Arn property </summary> <param name="arn">The value to set for the Arn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithContentConfig(Amazon.ElasticTranscoder.Model.PipelineOutputConfig)"> <summary> Sets the ContentConfig property </summary> <param name="contentConfig">The value to set for the ContentConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithInputBucket(System.String)"> <summary> Sets the InputBucket property </summary> <param name="inputBucket">The value to set for the InputBucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithNotifications(Amazon.ElasticTranscoder.Model.Notifications)"> <summary> Sets the Notifications property </summary> <param name="notifications">The value to set for the Notifications property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithOutputBucket(System.String)"> <summary> Sets the OutputBucket property </summary> <param name="outputBucket">The value to set for the OutputBucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithRole(System.String)"> <summary> Sets the Role property </summary> <param name="role">The value to set for the Role property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Pipeline.WithThumbnailConfig(Amazon.ElasticTranscoder.Model.PipelineOutputConfig)"> <summary> Sets the ThumbnailConfig property </summary> <param name="thumbnailConfig">The value to set for the ThumbnailConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) for the pipeline. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.ContentConfig"> <summary> Gets and sets the property ContentConfig. <para> Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both <code>ContentConfig</code> and <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>. </para> <ul> <li><b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.</li> <li><b>Permissions</b>: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have. <ul> <li>GranteeType: The type of value that appears in the <code>Grantee</code> object: <ul> <li><code>Canonical</code>: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.</li> <li><code>Email</code>: The registered email address of an AWS account.</li> <li><code>Group</code>: One of the following predefined Amazon S3 groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li> </ul> </li> <li><code>Grantee</code>: The AWS user or group that you want to have access to transcoded files and playlists.</li> <li><code>Access</code>: The permission that you want to give to the AWS user that is listed in <code>Grantee</code>. Valid values include: <ul> <li><code>READ</code>: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>READ_ACP</code>: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>WRITE_ACP</code>: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>FULL_CONTROL</code>: The grantee has <code>READ</code>, <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> </ul> </li> </ul> </li> <li><b>StorageClass</b>: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. </li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.Id"> <summary> Gets and sets the property Id. <para> The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.InputBucket"> <summary> Gets and sets the property InputBucket. <para> The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. </para> <para> Constraints: Maximum 40 characters </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.Notifications"> <summary> Gets and sets the property Notifications. <para> The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. </para> <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.</important> <ul> <li><b>Progressing</b> (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.</li> <li><b>Completed</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</li> <li><b>Warning</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</li> <li><b>Error</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.OutputBucket"> <summary> Gets and sets the property OutputBucket. <para> The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both <code>ContentConfig</code> and <code>ThumbnailConfig</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.Role"> <summary> Gets and sets the property Role. <para> The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.Status"> <summary> Gets and sets the property Status. <para> The current status of the pipeline: </para> <ul> <li><code>Active</code>: The pipeline is processing jobs.</li> <li><code>Paused</code>: The pipeline is not currently processing jobs.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Pipeline.ThumbnailConfig"> <summary> Gets and sets the property ThumbnailConfig. <para> Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both <code>ContentConfig</code> and <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>. </para> <ul> <li><code>Bucket</code>: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. </li> <li><code>Permissions</code>: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have. <ul> <li>GranteeType: The type of value that appears in the Grantee object: <ul> <li><code>Canonical</code>: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. <important>A canonical user ID is not the same as an AWS account number.</important></li> <li><code>Email</code>: The registered email address of an AWS account.</li> <li><code>Group</code>: One of the following predefined Amazon S3 groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li> </ul> </li> <li><code>Grantee</code>: The AWS user or group that you want to have access to thumbnail files.</li> <li>Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include: <ul> <li><code>READ</code>: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> </ul> </li> </ul> </li> <li><code>StorageClass</code>: The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.</li> </ul> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.PipelineOutputConfig"> <summary> The <code>PipelineOutputConfig</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.PipelineOutputConfig.WithBucket(System.String)"> <summary> Sets the Bucket property </summary> <param name="bucket">The value to set for the Bucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PipelineOutputConfig.WithPermissions(Amazon.ElasticTranscoder.Model.Permission[])"> <summary> Sets the Permissions property </summary> <param name="permissions">The values to add to the Permissions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PipelineOutputConfig.WithPermissions(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.Permission})"> <summary> Sets the Permissions property </summary> <param name="permissions">The values to add to the Permissions collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PipelineOutputConfig.WithStorageClass(System.String)"> <summary> Sets the StorageClass property </summary> <param name="storageClass">The value to set for the StorageClass property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.PipelineOutputConfig.Bucket"> <summary> Gets and sets the property Bucket. <para> The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true: <ul> <li>You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.</li> <li>You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.</li> <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li> <li>You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.</li> </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PipelineOutputConfig.Permissions"> <summary> Gets and sets the property Permissions. <para> Optional. The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. </para> <para> If you include <code>Permissions</code>, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by <code>Role</code>. If you want that user to have full control, you must explicitly grant full control to the user. </para> <para> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by <code>Role</code>, and grants no other permissions to any other user or group. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PipelineOutputConfig.StorageClass"> <summary> Gets and sets the property StorageClass. <para> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Playlist"> <summary> Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container is <code>ts</code> (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Playlist.WithFormat(System.String)"> <summary> Sets the Format property </summary> <param name="format">The value to set for the Format property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Playlist.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Playlist.WithOutputKeys(System.String[])"> <summary> Sets the OutputKeys property </summary> <param name="outputKeys">The values to add to the OutputKeys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Playlist.WithOutputKeys(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the OutputKeys property </summary> <param name="outputKeys">The values to add to the OutputKeys collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Playlist.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Playlist.WithStatusDetail(System.String)"> <summary> Sets the StatusDetail property </summary> <param name="statusDetail">The value to set for the StatusDetail property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Playlist.Format"> <summary> Gets and sets the property Format. <para> This value must currently be <code>HLSv3</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Playlist.Name"> <summary> Gets and sets the property Name. <para> The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. The name cannot include a / character. If you create more than one master playlist (not recommended), the values of all <code>Name</code> objects must be unique. <b>Note</b>: Elastic Transcoder automatically appends .m3u8 to the file name. If you include .m3u8 in <code>Name</code>, it will appear twice in the file name. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Playlist.OutputKeys"> <summary> Gets and sets the property OutputKeys. <para> For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object. If you include more than one output in a playlist, the value of <code>SegmentDuration</code> for all of the outputs must be the same. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Playlist.Status"> <summary> Gets and sets the property Status. <para> The status of the job with which the playlist is associated. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Playlist.StatusDetail"> <summary> Gets and sets the property StatusDetail. <para> Information that further explains the status. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Preset"> <summary> Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithArn(System.String)"> <summary> Sets the Arn property </summary> <param name="arn">The value to set for the Arn property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithAudio(Amazon.ElasticTranscoder.Model.AudioParameters)"> <summary> Sets the Audio property </summary> <param name="audio">The value to set for the Audio property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithContainer(System.String)"> <summary> Sets the Container property </summary> <param name="container">The value to set for the Container property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithThumbnails(Amazon.ElasticTranscoder.Model.Thumbnails)"> <summary> Sets the Thumbnails property </summary> <param name="thumbnails">The value to set for the Thumbnails property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithType(System.String)"> <summary> Sets the Type property </summary> <param name="type">The value to set for the Type property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Preset.WithVideo(Amazon.ElasticTranscoder.Model.VideoParameters)"> <summary> Sets the Video property </summary> <param name="video">The value to set for the Video property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) for the preset. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Audio"> <summary> Gets and sets the property Audio. <para> A section of the response body that provides information about the audio preset values. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Container"> <summary> Gets and sets the property Container. <para> The container type for the output file. Valid values include <code>mp3</code>, <code>mp4</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Description"> <summary> Gets and sets the property Description. <para> A description of the preset. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Id"> <summary> Gets and sets the property Id. <para> Identifier for the new preset. You use this value to get settings for the preset or to delete it. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Name"> <summary> Gets and sets the property Name. <para> The name of the preset. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Thumbnails"> <summary> Gets and sets the property Thumbnails. <para> A section of the response body that provides information about the thumbnail preset values, if any. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Type"> <summary> Gets and sets the property Type. <para> Whether the preset is a default preset provided by Elastic Transcoder (<code>System</code>) or a preset that you have defined (<code>Custom</code>). </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Preset.Video"> <summary> Gets and sets the property Video. <para> A section of the response body that provides information about the video preset values. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.PresetWatermark"> <summary> Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video. <para> Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency. </para> <para> When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions. </para> </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithHorizontalAlign(System.String)"> <summary> Sets the HorizontalAlign property </summary> <param name="horizontalAlign">The value to set for the HorizontalAlign property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithHorizontalOffset(System.String)"> <summary> Sets the HorizontalOffset property </summary> <param name="horizontalOffset">The value to set for the HorizontalOffset property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithMaxHeight(System.String)"> <summary> Sets the MaxHeight property </summary> <param name="maxHeight">The value to set for the MaxHeight property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithMaxWidth(System.String)"> <summary> Sets the MaxWidth property </summary> <param name="maxWidth">The value to set for the MaxWidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithOpacity(System.String)"> <summary> Sets the Opacity property </summary> <param name="opacity">The value to set for the Opacity property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithSizingPolicy(System.String)"> <summary> Sets the SizingPolicy property </summary> <param name="sizingPolicy">The value to set for the SizingPolicy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithTarget(System.String)"> <summary> Sets the Target property </summary> <param name="target">The value to set for the Target property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithVerticalAlign(System.String)"> <summary> Sets the VerticalAlign property </summary> <param name="verticalAlign">The value to set for the VerticalAlign property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.PresetWatermark.WithVerticalOffset(System.String)"> <summary> Sets the VerticalOffset property </summary> <param name="verticalOffset">The value to set for the VerticalOffset property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.HorizontalAlign"> <summary> Gets and sets the property HorizontalAlign. <para> The horizontal position of the watermark unless you specify a non-zero value for <code>HorizontalOffset</code>: <ul> <li><b>Left</b>: The left edge of the watermark is aligned with the left border of the video.</li> <li><b>Right</b>: The right edge of the watermark is aligned with the right border of the video.</li> <li><b>Center</b>: The watermark is centered between the left and right borders.</li></ul> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.HorizontalOffset"> <summary> Gets and sets the property HorizontalOffset. <para> The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign: <ul> <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.</li> <li>integer percentage (%): The range of valid values is 0 to 100.</li> </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from the left border of the output video. </para> <para> <code>HorizontalOffset</code> is only valid when the value of <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped. </para> <para> Use the value of <code>Target</code> to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.Id"> <summary> Gets and sets the property Id. A unique identifier for the settings for one watermark. The value of <code>Id</code> can be up to 40 characters long. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.MaxHeight"> <summary> Gets and sets the property MaxHeight. <para> The maximum height of the watermark in one of the following formats: <ul> <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of <code>MaxHeight</code>.</li> <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of <code>Target</code> to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.</li> </ul> If you specify the value in pixels, it must be less than or equal to the value of <code>MaxHeight</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.MaxWidth"> <summary> Gets and sets the property MaxWidth. <para> The maximum width of the watermark in one of the following formats: <ul> <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of <code>MaxWidth</code>.</li> <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of <code>Target</code> to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.</li> If you specify the value in pixels, it must be less than or equal to the value of <code>MaxWidth</code>.</ul> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.Opacity"> <summary> Gets and sets the property Opacity. <para> A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of <code>Opacity</code> is float. </para> <para> Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for <code>Opacity</code>. The .jpg file format doesn't support transparency. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.SizingPolicy"> <summary> Gets and sets the property SizingPolicy. <para> A value that controls scaling of the watermark: <ul> <li><b>Fit</b>: Elastic Transcoder scales the watermark so it matches the value that you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without exceeding the other value.</li> <li><b>Stretch</b>: Elastic Transcoder stretches the watermark to match the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative proportions of the watermark and the values of <code>MaxWidth</code> and <code>MaxHeight</code> are different, the watermark will be distorted.</li> <li><b>ShrinkToFit</b>: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.</li></ul> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.Target"> <summary> Gets and sets the property Target. <para> A value that determines how Elastic Transcoder interprets values that you specified for <code>HorizontalOffset</code>, <code>VerticalOffset</code>, <code>MaxWidth</code>, and <code>MaxHeight</code>: <ul><li><b>Content</b>: <code>HorizontalOffset</code> and <code>VerticalOffset</code> values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, <code>MaxWidth</code> and <code>MaxHeight</code>, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any.</li> <li><b>Frame</b>: <code>HorizontalOffset</code> and <code>VerticalOffset</code> values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.</li> In addition, <code>MaxWidth</code> and <code>MaxHeight</code>, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.</ul> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.VerticalAlign"> <summary> Gets and sets the property VerticalAlign. <para> The vertical position of the watermark unless you specify a non-zero value for <code>VerticalOffset</code>: <ul> <li><b>Top</b>: The top edge of the watermark is aligned with the top border of the video.</li> <li><b>Bottom</b>: The bottom edge of the watermark is aligned with the bottom border of the video.</li> <li><b>Center</b>: The watermark is centered between the top and bottom borders.</li></ul> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.PresetWatermark.VerticalOffset"> <summary> Gets and sets the property VerticalOffset. <code>VerticalOffset</code> <para> The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:<ul> <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of <code>MaxHeight</code>.</li> <li>integer percentage (%): The range of valid values is 0 to 100.</li> </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5 pixels from the top border of the output video. </para> <para> <code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or Bottom. </para> <para> If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped. </para> <para> Use the value of <code>Target</code> to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadJobRequest"> <summary> Container for the parameters to the ReadJob operation. The ReadJob operation returns detailed information about a job. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ReadJobRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadJobRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the job for which you want to get detailed information. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadJobResponse"> <summary> Returns information about the ReadJobResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadJobResponse.ReadJobResult"> <summary> Gets and sets the ReadJobResult property. Represents the output of a ReadJob operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadJobResult"> <summary> The <code>ReadJobResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ReadJobResult.WithJob(Amazon.ElasticTranscoder.Model.Job)"> <summary> Sets the Job property </summary> <param name="job">The value to set for the Job property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadJobResult.Job"> <summary> Gets and sets the property Job. <para> A section of the response body that provides information about the job. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadPipelineRequest"> <summary> Container for the parameters to the ReadPipeline operation. The ReadPipeline operation gets detailed information about a pipeline. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ReadPipelineRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadPipelineRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the pipeline to read. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadPipelineResponse"> <summary> Returns information about the ReadPipelineResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadPipelineResponse.ReadPipelineResult"> <summary> Gets and sets the ReadPipelineResult property. Represents the output of a ReadPipeline operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadPipelineResult"> <summary> The <code>ReadPipelineResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ReadPipelineResult.WithPipeline(Amazon.ElasticTranscoder.Model.Pipeline)"> <summary> Sets the Pipeline property </summary> <param name="pipeline">The value to set for the Pipeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadPipelineResult.Pipeline"> <summary> Gets and sets the property Pipeline. <para> A section of the response body that provides information about the pipeline. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadPresetRequest"> <summary> Container for the parameters to the ReadPreset operation. The ReadPreset operation gets detailed information about a preset. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ReadPresetRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadPresetRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the preset for which you want to get detailed information. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadPresetResponse"> <summary> Returns information about the ReadPresetResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadPresetResponse.ReadPresetResult"> <summary> Gets and sets the ReadPresetResult property. Represents the output of a ReadPreset operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ReadPresetResult"> <summary> The <code>ReadPresetResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ReadPresetResult.WithPreset(Amazon.ElasticTranscoder.Model.Preset)"> <summary> Sets the Preset property </summary> <param name="preset">The value to set for the Preset property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.ReadPresetResult.Preset"> <summary> Gets and sets the property Preset. <para> A section of the response body that provides information about the preset. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ResourceInUseException"> <summary> ElasticTranscoder exception </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ResourceInUseException.#ctor(System.String)"> <summary> Constructs a new ResourceInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticTranscoder.Model.ResourceNotFoundException"> <summary> ElasticTranscoder exception </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ResourceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ResourceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticTranscoder.Model.TestRoleRequest"> <summary> Container for the parameters to the TestRole operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleRequest.WithInputBucket(System.String)"> <summary> Sets the InputBucket property </summary> <param name="inputBucket">The value to set for the InputBucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleRequest.WithOutputBucket(System.String)"> <summary> Sets the OutputBucket property </summary> <param name="outputBucket">The value to set for the OutputBucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleRequest.WithRole(System.String)"> <summary> Sets the Role property </summary> <param name="role">The value to set for the Role property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleRequest.WithTopics(System.String[])"> <summary> Sets the Topics property </summary> <param name="topics">The values to add to the Topics collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleRequest.WithTopics(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Topics property </summary> <param name="topics">The values to add to the Topics collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.TestRoleRequest.InputBucket"> <summary> Gets and sets the property InputBucket. <para> The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.TestRoleRequest.OutputBucket"> <summary> Gets and sets the property OutputBucket. <para> The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to read from this bucket. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.TestRoleRequest.Role"> <summary> Gets and sets the property Role. <para> The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.TestRoleRequest.Topics"> <summary> Gets and sets the property Topics. <para> The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.TestRoleResponse"> <summary> Returns information about the TestRoleResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.TestRoleResponse.TestRoleResult"> <summary> Gets and sets the TestRoleResult property. Represents the output of a TestRole operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.TestRoleResult"> <summary> The <code>TestRoleResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleResult.WithMessages(System.String[])"> <summary> Sets the Messages property </summary> <param name="messages">The values to add to the Messages collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleResult.WithMessages(System.Collections.Generic.IEnumerable{System.String})"> <summary> Sets the Messages property </summary> <param name="messages">The values to add to the Messages collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.TestRoleResult.WithSuccess(System.String)"> <summary> Sets the Success property </summary> <param name="success">The value to set for the Success property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.TestRoleResult.Messages"> <summary> Gets and sets the property Messages. <para> If the <code>Success</code> element contains <code>false</code>, this value is an array of one or more error messages that were generated during the test process. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.TestRoleResult.Success"> <summary> Gets and sets the property Success. <para> If the operation is successful, this value is <code>true</code>; otherwise, the value is <code>false</code>. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.Thumbnails"> <summary> Thumbnails for videos. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithAspectRatio(System.String)"> <summary> Sets the AspectRatio property </summary> <param name="aspectRatio">The value to set for the AspectRatio property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithFormat(System.String)"> <summary> Sets the Format property </summary> <param name="format">The value to set for the Format property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithInterval(System.String)"> <summary> Sets the Interval property </summary> <param name="interval">The value to set for the Interval property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithMaxHeight(System.String)"> <summary> Sets the MaxHeight property </summary> <param name="maxHeight">The value to set for the MaxHeight property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithMaxWidth(System.String)"> <summary> Sets the MaxWidth property </summary> <param name="maxWidth">The value to set for the MaxWidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithPaddingPolicy(System.String)"> <summary> Sets the PaddingPolicy property </summary> <param name="paddingPolicy">The value to set for the PaddingPolicy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithResolution(System.String)"> <summary> Sets the Resolution property </summary> <param name="resolution">The value to set for the Resolution property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.Thumbnails.WithSizingPolicy(System.String)"> <summary> Sets the SizingPolicy property </summary> <param name="sizingPolicy">The value to set for the SizingPolicy property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.AspectRatio"> <summary> Gets and sets the property AspectRatio. <important> <para> To better control resolution and aspect ratio of thumbnails, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together. </para> </important> <para> The aspect ratio of thumbnails. Valid values include: </para> <para> <code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code> </para> <para> If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.Format"> <summary> Gets and sets the property Format. <para> The format of thumbnails, if any. Valid values are <code>jpg</code> and <code>png</code>. </para> <para> You specify whether you want Elastic Transcoder to create thumbnails when you create a job. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.Interval"> <summary> Gets and sets the property Interval. <para> The number of seconds between thumbnails. Specify an integer value. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.MaxHeight"> <summary> Gets and sets the property MaxHeight. <para> The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.MaxWidth"> <summary> Gets and sets the property MaxWidth. <para> The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.PaddingPolicy"> <summary> Gets and sets the property PaddingPolicy. <para> When you set <code>PaddingPolicy</code> to <code>Pad</code>, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> settings. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.Resolution"> <summary> Gets and sets the property Resolution. <important> <para> To better control resolution and aspect ratio of thumbnails, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together. </para> </important> <para> The width and height of thumbnail files in pixels. Specify a value in the format <code><i>width</i></code> x <code><i>height</i></code> where both values are even integers. The values cannot exceed the width and height that you specified in the <code>Video:Resolution</code> object. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.Thumbnails.SizingPolicy"> <summary> Gets and sets the property SizingPolicy. <para> Specify one of the following values to control scaling of thumbnails: </para> <para> <ul> <li><code>Fit</code>: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. </li> <li><code>Fill</code>: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail <code>MaxWidth</code> or <code>MaxHeight</code> settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.</li> <li><code>Stretch</code>: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.</li> <li><code>Keep</code>: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> settings, Elastic Transcoder crops the thumbnails.</li> <li><code>ShrinkToFit</code>: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.</li> <li><code>ShrinkToFill</code>: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.</li> </ul> </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.TimeSpan"> <summary> Settings that determine when a clip begins and how long it lasts. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.TimeSpan.WithDuration(System.String)"> <summary> Sets the Duration property </summary> <param name="duration">The value to set for the Duration property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.TimeSpan.WithStartTime(System.String)"> <summary> Sets the StartTime property </summary> <param name="startTime">The value to set for the StartTime property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.TimeSpan.Duration"> <summary> Gets and sets the property Duration. <para> The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file. </para> <para> If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.TimeSpan.StartTime"> <summary> Gets and sets the property StartTime. <para> The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest"> <summary> Container for the parameters to the UpdatePipelineNotifications operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest.WithNotifications(Amazon.ElasticTranscoder.Model.Notifications)"> <summary> Sets the Notifications property </summary> <param name="notifications">The value to set for the Notifications property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the pipeline for which you want to change notification settings. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsRequest.Notifications"> <summary> Gets and sets the property Notifications. <para> The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. </para> <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.</important> <ul> <li><b>Progressing</b>: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.</li> <li><b>Completed</b>: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.</li> <li><b>Warning</b>: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.</li> <li><b>Error</b>: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.</li> </ul> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsResponse"> <summary> Returns information about the UpdatePipelineNotificationsResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsResponse.UpdatePipelineNotificationsResult"> <summary> Gets and sets the UpdatePipelineNotificationsResult property. Represents the output of a UpdatePipelineNotifications operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsResult"> <summary> The <code>UpdatePipelineNotificationsResponse</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsResult.WithPipeline(Amazon.ElasticTranscoder.Model.Pipeline)"> <summary> Sets the Pipeline property </summary> <param name="pipeline">The value to set for the Pipeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineNotificationsResult.Pipeline"> <summary> Gets and sets the property Pipeline. <para> A section of the response body that provides information about the pipeline. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest"> <summary> Container for the parameters to the UpdatePipeline operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.WithContentConfig(Amazon.ElasticTranscoder.Model.PipelineOutputConfig)"> <summary> Sets the ContentConfig property </summary> <param name="contentConfig">The value to set for the ContentConfig property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.WithInputBucket(System.String)"> <summary> Sets the InputBucket property </summary> <param name="inputBucket">The value to set for the InputBucket property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.WithName(System.String)"> <summary> Sets the Name property </summary> <param name="name">The value to set for the Name property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.WithNotifications(Amazon.ElasticTranscoder.Model.Notifications)"> <summary> Sets the Notifications property </summary> <param name="notifications">The value to set for the Notifications property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.WithRole(System.String)"> <summary> Sets the Role property </summary> <param name="role">The value to set for the Role property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.WithThumbnailConfig(Amazon.ElasticTranscoder.Model.PipelineOutputConfig)"> <summary> Sets the ThumbnailConfig property </summary> <param name="thumbnailConfig">The value to set for the ThumbnailConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.ContentConfig"> <summary> Gets and sets the property ContentConfig. <para> The optional <code>ContentConfig</code> object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. </para> <para> If you specify values for <code>ContentConfig</code>, you must also specify values for <code>ThumbnailConfig</code>. </para> <para> If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>, omit the <code>OutputBucket</code> object. </para> <ul> <li><b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.</li> <li><b>Permissions</b> (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</li> <li><b>Grantee Type</b>: Specify the type of value that appears in the <code>Grantee</code> object: <ul> <li><b>Canonical</b>: The value in the <code>Grantee</code> object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content. <important>A canonical user ID is not the same as an AWS account number.</important> </li> <li><b>Email</b>: The value in the <code>Grantee</code> object is the registered email address of an AWS account.</li> <li><b>Group</b>: The value in the <code>Grantee</code> object is one of the following predefined Amazon S3 groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li> </ul> </li> <li> <b>Grantee</b>: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group </li> <li> <b>Access</b>: The permission that you want to give to the AWS user that you specified in <code>Grantee</code>. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include: <ul> <li><code>READ</code>: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>READ_ACP</code>: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. </li> <li><code>WRITE_ACP</code>: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>FULL_CONTROL</code>: The grantee has <code>READ</code>, <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> </ul> </li> <li> <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.Id"> <summary> Gets and sets the property Id. <para> The ID of the pipeline that you want to update. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.InputBucket"> <summary> Gets and sets the property InputBucket. <para> The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced. </para> <para> Constraints: Maximum 40 characters </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.Notifications"> <summary> Gets and sets the property Notifications. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.Role"> <summary> Gets and sets the property Role. <para> The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineRequest.ThumbnailConfig"> <summary> Gets and sets the property ThumbnailConfig. <para> The <code>ThumbnailConfig</code> object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files. </para> <para> If you specify values for <code>ContentConfig</code>, you must also specify values for <code>ThumbnailConfig</code> even if you don't want to create thumbnails. </para> <para> If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>, omit the <code>OutputBucket</code> object. </para> <ul> <li><b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.</li> <li><b>Permissions</b> (Optional): The <code>Permissions</code> object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.</li> <li> <b>GranteeType</b>: Specify the type of value that appears in the Grantee object: <ul> <li> <b>Canonical</b>: The value in the <code>Grantee</code> object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. <important>A canonical user ID is not the same as an AWS account number.</important></li> <li><b>Email</b>: The value in the <code>Grantee</code> object is the registered email address of an AWS account. </li> <li><b>Group</b>: The value in the <code>Grantee</code> object is one of the following predefined Amazon S3 groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li> </ul> </li> <li> <b>Grantee</b>: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group. </li> <li> <b>Access</b>: The permission that you want to give to the AWS user that you specified in <code>Grantee</code>. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include: <ul> <li><code>READ</code>: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. </li> <li><code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li> <li><code>FULL_CONTROL</code>: The grantee has <code>READ</code>, <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. </li> </ul> </li> <li> <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.</li> </ul> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineResponse"> <summary> Returns information about the UpdatePipelineResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineResponse.UpdatePipelineResult"> <summary> Gets and sets the UpdatePipelineResult property. Represents the output of a UpdatePipeline operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineResult"> <summary> When you update a pipeline, Elastic Transcoder returns the values that you specified in the request. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineResult.WithPipeline(Amazon.ElasticTranscoder.Model.Pipeline)"> <summary> Sets the Pipeline property </summary> <param name="pipeline">The value to set for the Pipeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineResult.Pipeline"> <summary> Gets and sets the property Pipeline. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest"> <summary> Container for the parameters to the UpdatePipelineStatus operation. 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> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest.WithId(System.String)"> <summary> Sets the Id property </summary> <param name="id">The value to set for the Id property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest.Id"> <summary> Gets and sets the property Id. <para> The identifier of the pipeline to update. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusRequest.Status"> <summary> Gets and sets the property Status. <para> The desired status of the pipeline: </para> <ul> <li> <code>Active</code>: The pipeline is processing jobs.</li> <li> <code>Paused</code>: The pipeline is not currently processing jobs.</li> </ul> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusResponse"> <summary> Returns information about the UpdatePipelineStatusResult response and response metadata. </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusResponse.UpdatePipelineStatusResult"> <summary> Gets and sets the UpdatePipelineStatusResult property. Represents the output of a UpdatePipelineStatus operation. </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusResult"> <summary> When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusResult.WithPipeline(Amazon.ElasticTranscoder.Model.Pipeline)"> <summary> Sets the Pipeline property </summary> <param name="pipeline">The value to set for the Pipeline property </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.UpdatePipelineStatusResult.Pipeline"> <summary> Gets and sets the property Pipeline. <para> A section of the response body that provides information about the pipeline. </para> </summary> </member> <member name="T:Amazon.ElasticTranscoder.Model.ValidationException"> <summary> ElasticTranscoder exception </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.ValidationException.#ctor(System.String)"> <summary> Constructs a new ValidationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ElasticTranscoder.Model.VideoParameters"> <summary> The <code>VideoParameters</code> structure. </summary> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithAspectRatio(System.String)"> <summary> Sets the AspectRatio property </summary> <param name="aspectRatio">The value to set for the AspectRatio property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithBitRate(System.String)"> <summary> Sets the BitRate property </summary> <param name="bitRate">The value to set for the BitRate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithCodec(System.String)"> <summary> Sets the Codec property </summary> <param name="codec">The value to set for the Codec property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithCodecOptions(System.Collections.Generic.KeyValuePair{System.String,System.String}[])"> <summary> Adds the KeyValuePairs to the CodecOptions dictionary. </summary> <param name="pairs">The pairs to be added to the CodecOptions dictionary.</param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithDisplayAspectRatio(System.String)"> <summary> Sets the DisplayAspectRatio property </summary> <param name="displayAspectRatio">The value to set for the DisplayAspectRatio property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithFixedGOP(System.String)"> <summary> Sets the FixedGOP property </summary> <param name="fixedGOP">The value to set for the FixedGOP property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithFrameRate(System.String)"> <summary> Sets the FrameRate property </summary> <param name="frameRate">The value to set for the FrameRate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithKeyframesMaxDist(System.String)"> <summary> Sets the KeyframesMaxDist property </summary> <param name="keyframesMaxDist">The value to set for the KeyframesMaxDist property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithMaxFrameRate(System.String)"> <summary> Sets the MaxFrameRate property </summary> <param name="maxFrameRate">The value to set for the MaxFrameRate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithMaxHeight(System.String)"> <summary> Sets the MaxHeight property </summary> <param name="maxHeight">The value to set for the MaxHeight property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithMaxWidth(System.String)"> <summary> Sets the MaxWidth property </summary> <param name="maxWidth">The value to set for the MaxWidth property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithPaddingPolicy(System.String)"> <summary> Sets the PaddingPolicy property </summary> <param name="paddingPolicy">The value to set for the PaddingPolicy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithResolution(System.String)"> <summary> Sets the Resolution property </summary> <param name="resolution">The value to set for the Resolution property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithSizingPolicy(System.String)"> <summary> Sets the SizingPolicy property </summary> <param name="sizingPolicy">The value to set for the SizingPolicy property </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithWatermarks(Amazon.ElasticTranscoder.Model.PresetWatermark[])"> <summary> Sets the Watermarks property </summary> <param name="watermarks">The values to add to the Watermarks collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.ElasticTranscoder.Model.VideoParameters.WithWatermarks(System.Collections.Generic.IEnumerable{Amazon.ElasticTranscoder.Model.PresetWatermark})"> <summary> Sets the Watermarks property </summary> <param name="watermarks">The values to add to the Watermarks collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.AspectRatio"> <summary> Gets and sets the property AspectRatio. <important> <para> To better control resolution and aspect ratio of output videos, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together. </para> </important> <para> The display aspect ratio of the video in the output file. Valid values include: </para> <para> <code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code> </para> <para> If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the input file. </para> <para> If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.BitRate"> <summary> Gets and sets the property BitRate. <para> The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of <code>Level</code> and <code>Profile</code>. If you specify <code>auto</code>, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than <code>auto</code>, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile: </para> <para> <i>Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)</i> </para> <ul> <li>1 - 64 : 80</li> <li>1b - 128 : 160</li> <li>1.1 - 192 : 240</li> <li>1.2 - 384 : 480</li> <li>1.3 - 768 : 960</li> <li>2 - 2000 : 2500</li> <li>3 - 10000 : 12500</li> <li>3.1 - 14000 : 17500</li> <li>3.2 - 20000 : 25000</li> <li>4 - 20000 : 25000</li> <li>4.1 - 50000 : 62500</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.Codec"> <summary> Gets and sets the property Codec. <para> The video codec for the output file. Valid values include <code>H.264</code> and <code>vp8</code>. You can only specify <code>vp8</code> when the container type is <code>webm</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.CodecOptions"> <summary> Gets and sets the property CodecOptions. <para> <b>Profile</b> </para> <para> The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles: </para> <ul> <li><code>baseline</code>: The profile most commonly used for videoconferencing and for mobile applications.</li> <li><code>main</code>: The profile used for standard-definition digital TV broadcasts.</li> <li><code>high</code>: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.</li> </ul> <para> <b>Level (H.264 Only)</b> </para> <para> The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels: </para> <para> <code>1</code>, <code>1b</code>, <code>1.1</code>, <code>1.2</code>, <code>1.3</code>, <code>2</code>, <code>2.1</code>, <code>2.2</code>, <code>3</code>, <code>3.1</code>, <code>3.2</code>, <code>4</code>, <code>4.1</code> </para> <para> <b>MaxReferenceFrames (H.264 Only)</b> </para> <para> Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following: </para> <para> <code>Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)</code> </para> <para> where <i>Width in pixels</i> and <i>Height in pixels</i> represent either MaxWidth and MaxHeight, or Resolution. <i>Maximum decoded picture buffer in macroblocks</i> depends on the value of the <code>Level</code> object. See the list below. (A macroblock is a block of pixels measuring 16x16.) </para> <ul> <li>1 - 396</li> <li>1b - 396</li> <li>1.1 - 900</li> <li>1.2 - 2376</li> <li>1.3 - 2376</li> <li>2 - 2376</li> <li>2.1 - 4752</li> <li>2.2 - 8100</li> <li>3 - 8100</li> <li>3.1 - 18000</li> <li>3.2 - 20480</li> <li>4 - 32768</li> <li>4.1 - 32768</li> </ul> <para> <b>MaxBitRate</b> </para> <para> The maximum number of bits per second in a video buffer; the size of the buffer is specified by <code>BufferSize</code>. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video. </para> <para> <b>BufferSize</b> </para> <para> The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify <code>MaxBitRate</code> and omit <code>BufferSize</code>, Elastic Transcoder sets <code>BufferSize</code> to 10 times the value of <code>MaxBitRate</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.DisplayAspectRatio"> <summary> Gets and sets the property DisplayAspectRatio. <para> The value that Elastic Transcoder adds to the metadata in the output file. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.FixedGOP"> <summary> Gets and sets the property FixedGOP. <para> Whether to use a fixed value for <code>FixedGOP</code>. Valid values are <code>true</code> and <code>false</code>: </para> <ul> <li><code>true</code>: Elastic Transcoder uses the value of <code>KeyframesMaxDist</code> for the distance between key frames (the number of frames in a group of pictures, or GOP).</li> <li><code>false</code>: The distance between key frames can vary.</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.FrameRate"> <summary> Gets and sets the property FrameRate. <para> The frames per second for the video stream in the output file. Valid values include: </para> <para> <code>auto</code>, <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code> </para> <para> If you specify <code>auto</code>, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation: </para> <para> <code>Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)</code> </para> <para> where: </para> <ul> <li><i>width in pixels</i> and <i>height in pixels</i> represent the Resolution of the output video.</li> <li><i>maximum recommended decoding speed in Luma samples/second</i> is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.</li> </ul> <para> The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (<i>Level - Decoding speed</i>): </para> <ul> <li>1 - 380160</li> <li>1b - 380160</li> <li>1.1 - 76800</li> <li>1.2 - 1536000</li> <li>1.3 - 3041280</li> <li>2 - 3041280</li> <li>2.1 - 5068800</li> <li>2.2 - 5184000</li> <li>3 - 10368000</li> <li>3.1 - 27648000</li> <li>3.2 - 55296000</li> <li>4 - 62914560</li> <li>4.1 - 62914560</li> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.KeyframesMaxDist"> <summary> Gets and sets the property KeyframesMaxDist. <para> The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.MaxFrameRate"> <summary> Gets and sets the property MaxFrameRate. <para> If you specify <code>auto</code> for <code>FrameRate</code>, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.MaxHeight"> <summary> Gets and sets the property MaxHeight. <para> The maximum height of the output video in pixels. If you specify <code>auto</code>, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.MaxWidth"> <summary> Gets and sets the property MaxWidth. <para> The maximum width of the output video in pixels. If you specify <code>auto</code>, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.PaddingPolicy"> <summary> Gets and sets the property PaddingPolicy. <para> When you set <code>PaddingPolicy</code> to <code>Pad</code>, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.Resolution"> <summary> Gets and sets the property Resolution. <important> <para> To better control resolution and aspect ratio of output videos, we recommend that you use the values <code>MaxWidth</code>, <code>MaxHeight</code>, <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do not use them together. </para> </important> <para> The width and height of the video in the output file, in pixels. Valid values are <code>auto</code> and <i>width</i> x <i>height</i>: </para> <ul> <li><code>auto</code>: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules.</li> <li><code><i>width</i> x <i>height</i></code>: The width and height of the output video in pixels.</li> </ul> <para> Note the following about specifying the width and height: </para> <ul> <li>The width must be an even integer between 128 and 4096, inclusive.</li> <li>The height must be an even integer between 96 and 3072, inclusive.</li> <li>If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.</li> <li>If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.</li> <li>We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (<i>List - Max width x height value</i>):</li> <ul> <li>1 - 25344</li> <li>1b - 25344</li> <li>1.1 - 101376</li> <li>1.2 - 101376</li> <li>1.3 - 101376</li> <li>2 - 101376</li> <li>2.1 - 202752</li> <li>2.2 - 404720</li> <li>3 - 404720</li> <li>3.1 - 921600</li> <li>3.2 - 1310720</li> <li>4 - 2097152</li> <li>4.1 - 2097152</li> </ul> </ul> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.SizingPolicy"> <summary> Gets and sets the property SizingPolicy. <para> Specify one of the following values to control scaling of the output video: </para> <para> <ul> <li><code>Fit</code>: Elastic Transcoder scales the output video so it matches the value that you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without exceeding the other value.</li> <li><code>Fill</code>: Elastic Transcoder scales the output video so it matches the value that you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.</li> <li><code>Stretch</code>: Elastic Transcoder stretches the output video to match the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative proportions of the input video and the output video are different, the output video will be distorted.</li> <li><code>Keep</code>: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>, Elastic Transcoder crops the output video.</li> <li><code>ShrinkToFit</code>: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up.</li> <li><code>ShrinkToFill</code>: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.</li> </ul> </para> </summary> </member> <member name="P:Amazon.ElasticTranscoder.Model.VideoParameters.Watermarks"> <summary> Gets and sets the property Watermarks. <para> Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video. </para> <para> Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency. </para> <para> When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions. </para> </summary> </member> <member name="T:Amazon.Glacier.AmazonGlacier"> <summary> Interface 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 <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.AmazonGlacier.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"> <summary> <para>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> <para>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <c>marker</c> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <c>marker</c> field is <c>null</c> . To return a list of vaults that begins at a specific vault, set the <c>marker</c> 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 <c>limit</c> 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="listVaultsRequest">Container for the necessary parameters to execute the ListVaults service method on AmazonGlacier.</param> <returns>The response from the ListVaults service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginListVaults(Amazon.Glacier.Model.ListVaultsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListVaults operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"/> </summary> <param name="listVaultsRequest">Container for the necessary parameters to execute the ListVaults operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVaults operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndListVaults(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListVaults operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListVaults.</param> <returns>Returns a ListVaultsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.ListVaults"> <summary> <para>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> <para>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <c>marker</c> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <c>marker</c> field is <c>null</c> . To return a list of vaults that begins at a specific vault, set the <c>marker</c> 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 <c>limit</c> 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 AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"> <summary> <para>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 InitiateJob. </para> <para><b>NOTE:</b> 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> <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="describeJobRequest">Container for the necessary parameters to execute the DescribeJob service method on AmazonGlacier.</param> <returns>The response from the DescribeJob service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginDescribeJob(Amazon.Glacier.Model.DescribeJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"/> </summary> <param name="describeJobRequest">Container for the necessary parameters to execute the DescribeJob operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJob operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndDescribeJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeJob.</param> <returns>Returns a DescribeJobResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.ListParts(Amazon.Glacier.Model.ListPartsRequest)"> <summary> <para>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 CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. </para> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of parts that begins at a specific part, set the <c>marker</c> 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 <c>limit</c> 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="listPartsRequest">Container for the necessary parameters to execute the ListParts service method on AmazonGlacier.</param> <returns>The response from the ListParts service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginListParts(Amazon.Glacier.Model.ListPartsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListParts operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListParts(Amazon.Glacier.Model.ListPartsRequest)"/> </summary> <param name="listPartsRequest">Container for the necessary parameters to execute the ListParts operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndListParts(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListParts operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListParts(Amazon.Glacier.Model.ListPartsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListParts.</param> <returns>Returns a ListPartsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"> <summary> <para>This operation retrieves the <c>notification-configuration</c> subresource of the specified vault.</para> <para>For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a <c>404 Not Found</c> 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="getVaultNotificationsRequest">Container for the necessary parameters to execute the GetVaultNotifications service method on AmazonGlacier.</param> <returns>The response from the GetVaultNotifications service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginGetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"/> </summary> <param name="getVaultNotificationsRequest">Container for the necessary parameters to execute the GetVaultNotifications operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetVaultNotifications operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndGetVaultNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetVaultNotifications.</param> <returns>Returns a GetVaultNotificationsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"> <summary> <para>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. </para> <para><b>NOTE:</b> 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> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of jobs that begins at a specific job, set the <c>marker</c> 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 <c>limit</c> parameter in the request.</para> <para>Additionally, you can filter the jobs list returned by specifying an optional <c>statuscode</c> (InProgress, Succeeded, or Failed) and <c>completed</c> (true, false) parameter. The <c>statuscode</c> allows you to specify that only jobs that match a specified status are returned. The <c>completed</c> 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="listJobsRequest">Container for the necessary parameters to execute the ListJobs service method on AmazonGlacier.</param> <returns>The response from the ListJobs service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginListJobs(Amazon.Glacier.Model.ListJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobs operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"/> </summary> <param name="listJobsRequest">Container for the necessary parameters to execute the ListJobs operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobs operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndListJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobs operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobs.</param> <returns>Returns a ListJobsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"> <summary> <para>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> <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="createVaultRequest">Container for the necessary parameters to execute the CreateVault service method on AmazonGlacier.</param> <returns>The response from the CreateVault service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.LimitExceededException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginCreateVault(Amazon.Glacier.Model.CreateVaultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"/> </summary> <param name="createVaultRequest">Container for the necessary parameters to execute the CreateVault operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVault operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndCreateVault(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVault.</param> <returns>Returns a CreateVaultResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"> <summary> <para>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 UploadMultipartPart).</para> <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 UploadMultipartPart), 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> <para><b>NOTE:</b> 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> <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="initiateMultipartUploadRequest">Container for the necessary parameters to execute the InitiateMultipartUpload service method on AmazonGlacier.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginInitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the InitiateMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"/> </summary> <param name="initiateMultipartUploadRequest">Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndInitiateMultipartUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the InitiateMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginInitiateMultipartUpload.</param> <returns>Returns a InitiateMultipartUploadResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"> <summary> <para>This operation aborts a multipart upload identified by the upload ID.</para> <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 UploadMultipartPart and CompleteMultipartUpload.</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="abortMultipartUploadRequest">Container for the necessary parameters to execute the AbortMultipartUpload service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginAbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AbortMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"/> </summary> <param name="abortMultipartUploadRequest">Container for the necessary parameters to execute the AbortMultipartUpload operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndAbortMultipartUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AbortMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAbortMultipartUpload.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"> <summary> <para>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:</para> <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="deleteArchiveRequest">Container for the necessary parameters to execute the DeleteArchive service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginDeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"/> </summary> <param name="deleteArchiveRequest">Container for the necessary parameters to execute the DeleteArchive operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndDeleteArchive(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteArchive.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"> <summary> <para>This operation downloads the output of the job you initiated using InitiateJob. 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> <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 <c>Range</c> 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 <c>Range</c> header.</para> </li> <li> <para>Along with the data, the response includes a checksum 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 DescribeJob 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="getJobOutputRequest">Container for the necessary parameters to execute the GetJobOutput service method on AmazonGlacier.</param> <returns>The response from the GetJobOutput service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginGetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetJobOutput operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"/> </summary> <param name="getJobOutputRequest">Container for the necessary parameters to execute the GetJobOutput operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJobOutput operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndGetJobOutput(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetJobOutput operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetJobOutput.</param> <returns>Returns a GetJobOutputResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"> <summary> <para>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> <para>Retrieving data from Amazon Glacier is a two-step process: </para> <ol> <li> <para>Initiate a retrieval job.</para> </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 GetJobOutput 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 SetVaultNotifications.</para> </li> <li> <para> <b>Get job details</b> You can make a DescribeJob 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> <para><b>NOTE:</b> The information you get via notification is same that you get by calling DescribeJob. </para> <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 SetVaultNotifications.</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 <c>StartDate</c> and <c>EndDate</c> by specifying values for these parameters in the <b>InitiateJob</b> request. Archives created on or after the <c>StartDate</c> and before the <c>EndDate</c> will be returned. If you only provide the <c>StartDate</c> without the <c>EndDate</c> , you will retrieve the inventory for all archives created on or after the <c>StartDate</c> . If you only provide the <c>EndDate</c> without the <c>StartDate</c> , you will get back the inventory for all archives created before the <c>EndDate</c> .</para> <para> <i>Limiting Inventory Items per Retrieval</i> </para> <para>You can limit the number of inventory items returned by setting the <c>Limit</c> parameter in the <b>InitiateJob</b> request. The inventory job output will contain inventory items up to the specified <c>Limit</c> . If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob 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 <c>Limit</c> 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="initiateJobRequest">Container for the necessary parameters to execute the InitiateJob service method on AmazonGlacier.</param> <returns>The response from the InitiateJob service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginInitiateJob(Amazon.Glacier.Model.InitiateJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the InitiateJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"/> </summary> <param name="initiateJobRequest">Container for the necessary parameters to execute the InitiateJob operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateJob operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndInitiateJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the InitiateJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginInitiateJob.</param> <returns>Returns a InitiateJobResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"> <summary> <para>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 <c>x-amz-archive-id</c> header of the response. </para> <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 InitiateJob. </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 InitiateJob. 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="uploadArchiveRequest">Container for the necessary parameters to execute the UploadArchive service method on AmazonGlacier.</param> <returns>The response from the UploadArchive service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginUploadArchive(Amazon.Glacier.Model.UploadArchiveRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"/> </summary> <param name="uploadArchiveRequest">Container for the necessary parameters to execute the UploadArchive operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadArchive operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndUploadArchive(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadArchive.</param> <returns>Returns a UploadArchiveResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"> <summary> <para>This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. </para> <para>To configure vault notifications, send a PUT request to the <c>notification-configuration</c> 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 (InitiateJob). 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 DescribeJob. </li> <li> <b>InventoryRetrievalCompleted</b> This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). 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 DescribeJob. </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="setVaultNotificationsRequest">Container for the necessary parameters to execute the SetVaultNotifications service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginSetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"/> </summary> <param name="setVaultNotificationsRequest">Container for the necessary parameters to execute the SetVaultNotifications operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndSetVaultNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetVaultNotifications.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"> <summary> <para>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 InitiateJob.</para> <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 ListParts 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="completeMultipartUploadRequest">Container for the necessary parameters to execute the CompleteMultipartUpload service method on AmazonGlacier.</param> <returns>The response from the CompleteMultipartUpload service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginCompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CompleteMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"/> </summary> <param name="completeMultipartUploadRequest">Container for the necessary parameters to execute the CompleteMultipartUpload operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteMultipartUpload operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndCompleteMultipartUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CompleteMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCompleteMultipartUpload.</param> <returns>Returns a CompleteMultipartUploadResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"> <summary> <para>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> <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 InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.</para> <para><b>NOTE:</b> 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> </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="uploadMultipartPartRequest">Container for the necessary parameters to execute the UploadMultipartPart service method on AmazonGlacier.</param> <returns>The response from the UploadMultipartPart service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginUploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadMultipartPart operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"/> </summary> <param name="uploadMultipartPartRequest">Container for the necessary parameters to execute the UploadMultipartPart operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadMultipartPart operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndUploadMultipartPart(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadMultipartPart operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadMultipartPart.</param> <returns>Returns a UploadMultipartPartResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"> <summary> <para>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 InitiateJob. 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> <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="describeVaultRequest">Container for the necessary parameters to execute the DescribeVault service method on AmazonGlacier.</param> <returns>The response from the DescribeVault service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginDescribeVault(Amazon.Glacier.Model.DescribeVaultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"/> </summary> <param name="describeVaultRequest">Container for the necessary parameters to execute the DescribeVault operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVault operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndDescribeVault(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVault.</param> <returns>Returns a DescribeVaultResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"> <summary> <para>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> <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="deleteVaultNotificationsRequest">Container for the necessary parameters to execute the DeleteVaultNotifications service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginDeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"/> </summary> <param name="deleteVaultNotificationsRequest">Container for the necessary parameters to execute the DeleteVaultNotifications operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndDeleteVaultNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVaultNotifications.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"> <summary> <para>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 InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. </para> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of multipart uploads that begins at a specific upload, set the <c>marker</c> 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 <c>limit</c> parameter in the request.</para> <para>Note the difference between this operation and listing parts (ListParts). 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="listMultipartUploadsRequest">Container for the necessary parameters to execute the ListMultipartUploads service method on AmazonGlacier.</param> <returns>The response from the ListMultipartUploads service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMultipartUploads operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"/> </summary> <param name="listMultipartUploadsRequest">Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndListMultipartUploads(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListMultipartUploads operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMultipartUploads.</param> <returns>Returns a ListMultipartUploadsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacier.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"> <summary> <para>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 DescribeVault 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> <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="deleteVaultRequest">Container for the necessary parameters to execute the DeleteVault service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacier.BeginDeleteVault(Amazon.Glacier.Model.DeleteVaultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"/> </summary> <param name="deleteVaultRequest">Container for the necessary parameters to execute the DeleteVault operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacier.EndDeleteVault(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVault.</param> </member> <member name="T:Amazon.Glacier.AmazonGlacierClient"> <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 <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 <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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonGlacier 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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings. </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.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"> <summary> <para>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> <para>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <c>marker</c> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <c>marker</c> field is <c>null</c> . To return a list of vaults that begins at a specific vault, set the <c>marker</c> 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 <c>limit</c> 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="listVaultsRequest">Container for the necessary parameters to execute the ListVaults service method on AmazonGlacier.</param> <returns>The response from the ListVaults service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginListVaults(Amazon.Glacier.Model.ListVaultsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListVaults operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"/> </summary> <param name="listVaultsRequest">Container for the necessary parameters to execute the ListVaults operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVaults operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndListVaults(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListVaults operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListVaults.</param> <returns>Returns a ListVaultsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListVaults"> <summary> <para>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> <para>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <c>marker</c> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <c>marker</c> field is <c>null</c> . To return a list of vaults that begins at a specific vault, set the <c>marker</c> 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 <c>limit</c> 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 AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"> <summary> <para>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 InitiateJob. </para> <para><b>NOTE:</b> 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> <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="describeJobRequest">Container for the necessary parameters to execute the DescribeJob service method on AmazonGlacier.</param> <returns>The response from the DescribeJob service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginDescribeJob(Amazon.Glacier.Model.DescribeJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"/> </summary> <param name="describeJobRequest">Container for the necessary parameters to execute the DescribeJob operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeJob operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndDescribeJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeJob.</param> <returns>Returns a DescribeJobResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListParts(Amazon.Glacier.Model.ListPartsRequest)"> <summary> <para>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 CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. </para> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of parts that begins at a specific part, set the <c>marker</c> 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 <c>limit</c> 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="listPartsRequest">Container for the necessary parameters to execute the ListParts service method on AmazonGlacier.</param> <returns>The response from the ListParts service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginListParts(Amazon.Glacier.Model.ListPartsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListParts operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListParts(Amazon.Glacier.Model.ListPartsRequest)"/> </summary> <param name="listPartsRequest">Container for the necessary parameters to execute the ListParts operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListParts operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndListParts(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListParts operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListParts(Amazon.Glacier.Model.ListPartsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListParts.</param> <returns>Returns a ListPartsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"> <summary> <para>This operation retrieves the <c>notification-configuration</c> subresource of the specified vault.</para> <para>For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a <c>404 Not Found</c> 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="getVaultNotificationsRequest">Container for the necessary parameters to execute the GetVaultNotifications service method on AmazonGlacier.</param> <returns>The response from the GetVaultNotifications service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginGetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"/> </summary> <param name="getVaultNotificationsRequest">Container for the necessary parameters to execute the GetVaultNotifications operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetVaultNotifications operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndGetVaultNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetVaultNotifications.</param> <returns>Returns a GetVaultNotificationsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"> <summary> <para>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. </para> <para><b>NOTE:</b> 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> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of jobs that begins at a specific job, set the <c>marker</c> 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 <c>limit</c> parameter in the request.</para> <para>Additionally, you can filter the jobs list returned by specifying an optional <c>statuscode</c> (InProgress, Succeeded, or Failed) and <c>completed</c> (true, false) parameter. The <c>statuscode</c> allows you to specify that only jobs that match a specified status are returned. The <c>completed</c> 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="listJobsRequest">Container for the necessary parameters to execute the ListJobs service method on AmazonGlacier.</param> <returns>The response from the ListJobs service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginListJobs(Amazon.Glacier.Model.ListJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobs operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"/> </summary> <param name="listJobsRequest">Container for the necessary parameters to execute the ListJobs operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListJobs operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndListJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobs operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobs.</param> <returns>Returns a ListJobsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"> <summary> <para>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> <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="createVaultRequest">Container for the necessary parameters to execute the CreateVault service method on AmazonGlacier.</param> <returns>The response from the CreateVault service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.LimitExceededException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginCreateVault(Amazon.Glacier.Model.CreateVaultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"/> </summary> <param name="createVaultRequest">Container for the necessary parameters to execute the CreateVault operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVault operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndCreateVault(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVault.</param> <returns>Returns a CreateVaultResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"> <summary> <para>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 UploadMultipartPart).</para> <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 UploadMultipartPart), 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> <para><b>NOTE:</b> 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> <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="initiateMultipartUploadRequest">Container for the necessary parameters to execute the InitiateMultipartUpload service method on AmazonGlacier.</param> <returns>The response from the InitiateMultipartUpload service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginInitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the InitiateMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"/> </summary> <param name="initiateMultipartUploadRequest">Container for the necessary parameters to execute the InitiateMultipartUpload operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateMultipartUpload operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndInitiateMultipartUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the InitiateMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginInitiateMultipartUpload.</param> <returns>Returns a InitiateMultipartUploadResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"> <summary> <para>This operation aborts a multipart upload identified by the upload ID.</para> <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 UploadMultipartPart and CompleteMultipartUpload.</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="abortMultipartUploadRequest">Container for the necessary parameters to execute the AbortMultipartUpload service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginAbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AbortMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"/> </summary> <param name="abortMultipartUploadRequest">Container for the necessary parameters to execute the AbortMultipartUpload operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndAbortMultipartUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AbortMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAbortMultipartUpload.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"> <summary> <para>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:</para> <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="deleteArchiveRequest">Container for the necessary parameters to execute the DeleteArchive service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginDeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"/> </summary> <param name="deleteArchiveRequest">Container for the necessary parameters to execute the DeleteArchive operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndDeleteArchive(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteArchive.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"> <summary> <para>This operation downloads the output of the job you initiated using InitiateJob. 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> <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 <c>Range</c> 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 <c>Range</c> header.</para> </li> <li> <para>Along with the data, the response includes a checksum 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 DescribeJob 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="getJobOutputRequest">Container for the necessary parameters to execute the GetJobOutput service method on AmazonGlacier.</param> <returns>The response from the GetJobOutput service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginGetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetJobOutput operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"/> </summary> <param name="getJobOutputRequest">Container for the necessary parameters to execute the GetJobOutput operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJobOutput operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndGetJobOutput(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetJobOutput operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetJobOutput.</param> <returns>Returns a GetJobOutputResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"> <summary> <para>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> <para>Retrieving data from Amazon Glacier is a two-step process: </para> <ol> <li> <para>Initiate a retrieval job.</para> </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 GetJobOutput 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 SetVaultNotifications.</para> </li> <li> <para> <b>Get job details</b> You can make a DescribeJob 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> <para><b>NOTE:</b> The information you get via notification is same that you get by calling DescribeJob. </para> <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 SetVaultNotifications.</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 <c>StartDate</c> and <c>EndDate</c> by specifying values for these parameters in the <b>InitiateJob</b> request. Archives created on or after the <c>StartDate</c> and before the <c>EndDate</c> will be returned. If you only provide the <c>StartDate</c> without the <c>EndDate</c> , you will retrieve the inventory for all archives created on or after the <c>StartDate</c> . If you only provide the <c>EndDate</c> without the <c>StartDate</c> , you will get back the inventory for all archives created before the <c>EndDate</c> .</para> <para> <i>Limiting Inventory Items per Retrieval</i> </para> <para>You can limit the number of inventory items returned by setting the <c>Limit</c> parameter in the <b>InitiateJob</b> request. The inventory job output will contain inventory items up to the specified <c>Limit</c> . If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob 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 <c>Limit</c> 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="initiateJobRequest">Container for the necessary parameters to execute the InitiateJob service method on AmazonGlacier.</param> <returns>The response from the InitiateJob service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginInitiateJob(Amazon.Glacier.Model.InitiateJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the InitiateJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"/> </summary> <param name="initiateJobRequest">Container for the necessary parameters to execute the InitiateJob operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndInitiateJob operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndInitiateJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the InitiateJob operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginInitiateJob.</param> <returns>Returns a InitiateJobResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"> <summary> <para>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 <c>x-amz-archive-id</c> header of the response. </para> <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 InitiateJob. </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 InitiateJob. 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="uploadArchiveRequest">Container for the necessary parameters to execute the UploadArchive service method on AmazonGlacier.</param> <returns>The response from the UploadArchive service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginUploadArchive(Amazon.Glacier.Model.UploadArchiveRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"/> </summary> <param name="uploadArchiveRequest">Container for the necessary parameters to execute the UploadArchive operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadArchive operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndUploadArchive(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadArchive operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadArchive.</param> <returns>Returns a UploadArchiveResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"> <summary> <para>This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. </para> <para>To configure vault notifications, send a PUT request to the <c>notification-configuration</c> 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 (InitiateJob). 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 DescribeJob. </li> <li> <b>InventoryRetrievalCompleted</b> This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). 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 DescribeJob. </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="setVaultNotificationsRequest">Container for the necessary parameters to execute the SetVaultNotifications service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginSetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"/> </summary> <param name="setVaultNotificationsRequest">Container for the necessary parameters to execute the SetVaultNotifications operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndSetVaultNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetVaultNotifications.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"> <summary> <para>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 InitiateJob.</para> <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 ListParts 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="completeMultipartUploadRequest">Container for the necessary parameters to execute the CompleteMultipartUpload service method on AmazonGlacier.</param> <returns>The response from the CompleteMultipartUpload service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginCompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CompleteMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"/> </summary> <param name="completeMultipartUploadRequest">Container for the necessary parameters to execute the CompleteMultipartUpload operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCompleteMultipartUpload operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndCompleteMultipartUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CompleteMultipartUpload operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCompleteMultipartUpload.</param> <returns>Returns a CompleteMultipartUploadResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"> <summary> <para>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> <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 InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.</para> <para><b>NOTE:</b> 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> </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="uploadMultipartPartRequest">Container for the necessary parameters to execute the UploadMultipartPart service method on AmazonGlacier.</param> <returns>The response from the UploadMultipartPart service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.RequestTimeoutException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginUploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadMultipartPart operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"/> </summary> <param name="uploadMultipartPartRequest">Container for the necessary parameters to execute the UploadMultipartPart operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadMultipartPart operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndUploadMultipartPart(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadMultipartPart operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadMultipartPart.</param> <returns>Returns a UploadMultipartPartResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"> <summary> <para>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 InitiateJob. 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> <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="describeVaultRequest">Container for the necessary parameters to execute the DescribeVault service method on AmazonGlacier.</param> <returns>The response from the DescribeVault service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginDescribeVault(Amazon.Glacier.Model.DescribeVaultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"/> </summary> <param name="describeVaultRequest">Container for the necessary parameters to execute the DescribeVault operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVault operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndDescribeVault(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVault.</param> <returns>Returns a DescribeVaultResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"> <summary> <para>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> <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="deleteVaultNotificationsRequest">Container for the necessary parameters to execute the DeleteVaultNotifications service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginDeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"/> </summary> <param name="deleteVaultNotificationsRequest">Container for the necessary parameters to execute the DeleteVaultNotifications operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndDeleteVaultNotifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVaultNotifications operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVaultNotifications.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"> <summary> <para>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 InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. </para> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of multipart uploads that begins at a specific upload, set the <c>marker</c> 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 <c>limit</c> parameter in the request.</para> <para>Note the difference between this operation and listing parts (ListParts). 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="listMultipartUploadsRequest">Container for the necessary parameters to execute the ListMultipartUploads service method on AmazonGlacier.</param> <returns>The response from the ListMultipartUploads service method, as returned by AmazonGlacier.</returns> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMultipartUploads operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"/> </summary> <param name="listMultipartUploadsRequest">Container for the necessary parameters to execute the ListMultipartUploads operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMultipartUploads operation.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndListMultipartUploads(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListMultipartUploads operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMultipartUploads.</param> <returns>Returns a ListMultipartUploadsResult from AmazonGlacier.</returns> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"> <summary> <para>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 DescribeVault 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> <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="deleteVaultRequest">Container for the necessary parameters to execute the DeleteVault service method on AmazonGlacier.</param> <exception cref="T:Amazon.Glacier.Model.ResourceNotFoundException"/> <exception cref="T:Amazon.Glacier.Model.MissingParameterValueException"/> <exception cref="T:Amazon.Glacier.Model.ServiceUnavailableException"/> <exception cref="T:Amazon.Glacier.Model.InvalidParameterValueException"/> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.BeginDeleteVault(Amazon.Glacier.Model.DeleteVaultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"/> </summary> <param name="deleteVaultRequest">Container for the necessary parameters to execute the DeleteVault operation on AmazonGlacier.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.EndDeleteVault(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVault operation. <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVault.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierClient.ProcessRequestHandlers(Amazon.Runtime.Internal.IRequest)"> <summary> Add API version header </summary> <param name="request"></param> </member> <member name="T:Amazon.Glacier.AmazonGlacierConfig"> <summary> Configuration for accessing service </summary> </member> <member name="M:Amazon.Glacier.AmazonGlacierConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.Glacier.AmazonGlacierConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.Glacier.AmazonGlacierConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.Glacier.AmazonGlacierExtensions"> <summary> Extension methods for Amazon Glacier. </summary> </member> <member name="M:Amazon.Glacier.AmazonGlacierExtensions.SetRange(Amazon.Glacier.Model.GetJobOutputRequest,System.Int64,System.Nullable{System.Int64})"> <summary> Creates the range formatted string and set the Range property. </summary> <param name="request"></param> <param name="start">The start of the range.</param> <param name="end">The end of the range. This can be null which would return the data to the end.</param> </member> <member name="M:Amazon.Glacier.AmazonGlacierExtensions.SetRange(Amazon.Glacier.Model.UploadMultipartPartRequest,System.Int64,System.Int64)"> <summary> Creates the range formatted string and set the Range property. </summary> <param name="request"></param> <param name="start">The start of the range.</param> <param name="end">The end of the range.</param> </member> <member name="T:Amazon.Glacier.GlacierUtils"> <summary> This class defines utility methods and constants for use with Glacier service. </summary> </member> <member name="F:Amazon.Glacier.GlacierUtils.JOB_STATUS_INPROGRESS"> <summary> Constant for in progress job status </summary> </member> <member name="F:Amazon.Glacier.GlacierUtils.JOB_STATUS_FAILED"> <summary> Constant for failed job status </summary> </member> <member name="F:Amazon.Glacier.GlacierUtils.JOB_STATUS_SUCCEEDED"> <summary> Constant for succeeded job status </summary> </member> <member name="M:Amazon.Glacier.GlacierUtils.CreatePartStream(System.IO.Stream,System.Int64)"> <summary> Creates a stream that wraps the passed in stream with the length of the stream set to the part size. This is useful when using multi part upload API by wrapping the stream being uploaded and setting it to the Body property on the UploadMultipartPartRequest object. </summary> <param name="stream">Stream that is wrapped.</param> <param name="partSize">The part size to be read from the original stream.</param> <returns></returns> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.InventoryRetrievalJobDescriptionUnmarshaller"> <summary> InventoryRetrievalJobDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.InventoryRetrievalJobDescription"> <summary> <para>Describes the options for a range inventory retrieval job.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobDescription.WithFormat(System.String)"> <summary> Sets the Format property </summary> <param name="format">The value to set for the Format property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobDescription.WithStartDate(System.String)"> <summary> Sets the StartDate property </summary> <param name="startDate">The value to set for the StartDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobDescription.WithEndDate(System.String)"> <summary> Sets the EndDate property </summary> <param name="endDate">The value to set for the EndDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobDescription.WithLimit(System.String)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobDescription.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobDescription.Format"> <summary> The output format for the vault inventory list, which is set by the <b>InitiateJob</b> request when initiating a job to retrieve a vault inventory. Valid values are "CSV" and "JSON". </summary> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobDescription.StartDate"> <summary> The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. </summary> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobDescription.EndDate"> <summary> The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. </summary> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobDescription.Limit"> <summary> Specifies the maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a <b>InitiateJob</b> request. </summary> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobDescription.Marker"> <summary> An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new <b>InitiateJob</b> request to obtain additional inventory items. If there are no more inventory items, this value is <c>null</c>. For more information, see <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html#api-initiate-job-post-vault-inventory-list-filtering"> Range Inventory Retrieval</a>. </summary> </member> <member name="T:Amazon.Glacier.Model.InventoryRetrievalJobInput"> <summary> <para>Provides options for specifying a range inventory retrieval job.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobInput.WithStartDate(System.String)"> <summary> Sets the StartDate property </summary> <param name="startDate">The value to set for the StartDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobInput.WithEndDate(System.String)"> <summary> Sets the EndDate property </summary> <param name="endDate">The value to set for the EndDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobInput.WithLimit(System.String)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InventoryRetrievalJobInput.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobInput.StartDate"> <summary> The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. </summary> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobInput.EndDate"> <summary> The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. A string representation of ISO 8601 date format, for example, 2013-03-20T17:03:43Z. </summary> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobInput.Limit"> <summary> Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1. </summary> </member> <member name="P:Amazon.Glacier.Model.InventoryRetrievalJobInput.Marker"> <summary> An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new <b>InitiateJob</b> request to obtain additional inventory items. If there are no more inventory items, this value is <c>null</c>. </summary> </member> <member name="T:Amazon.Glacier.Transfer.ArchiveTransferManager"> <summary> Provides a high level API for managing transfers to and from Amazon Glacier. This removes complexities such as breaking files into parts and computing check sums. </summary> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs an ArchiveTransferManager object for the specified Amazon Glacier region endpoint using 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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> </code> </summary> <param name="region">Amazon Glacier region endpoint</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.#ctor(Amazon.Glacier.AmazonGlacier)"> <summary> Constructs an ArchiveTransferManager object using an existing Amazon Glacier client. </summary> <param name="glacier">An AmazonGlacier client that used to make service calls.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs an ArchiveTransferManager object using the specified AWS credentials and Amazon Glacier region endpoint. </summary> <param name="credentials">AWS Credentials</param> <param name="region">Amazon Glacier region endpoint</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs an ArchiveTransferManager object with the specified AWS Access Key ID, AWS Secret Key, and Amazon Glacier region endpoint. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">Amazon Glacier region endpoint</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.Dispose"> <summary> Disposes of allocated resources and initiates garbage collection for the <see cref="T:Amazon.Glacier.Transfer.ArchiveTransferManager"/> object. </summary> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.CreateVault(System.String)"> <summary> Creates a vault. </summary> <param name="vaultName">The name of the vault to create.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.DeleteVault(System.String)"> <summary> Deletes the specified vault. Before deletion, the vault must be empty of all archives. </summary> <param name="vaultName">The name of the vault to delete.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.DeleteArchive(System.String,System.String)"> <summary> Deletes an archive specified by vault name and archive ID. </summary> <param name="vaultName">The name of the vault containing the archive.</param> <param name="archiveId">The archive ID of the archive to delete.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.Upload(System.String,System.String,System.String)"> <summary> Uploads the specified file to Amazon Glacier for archival storage in the specified vault in the specified user's account. For small archives, this method uploads the archive directly to Glacier. For larger archives, this method uses Glacier's multipart upload API to split the upload into multiple parts for better error recovery if any errors are encountered while streaming the data to Amazon Glacier. </summary> <param name="vaultName">The name of the vault to upload the file to.</param> <param name="archiveDescription">A description for the archive.</param> <param name="filepath">The file path to the file to upload.</param> <returns>The results of the upload including the archive ID.</returns> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.Upload(System.String,System.String,System.String,Amazon.Glacier.Transfer.UploadOptions)"> <summary> <para> Uploads the specified file to Amazon Glacier for archival storage in the specified vault in the specified user's account. For small archives, this method uploads the archive directly to Glacier. For larger archives, this method uses Glacier's multipart upload API to split the upload into multiple parts for better error recovery if any errors are encountered while streaming the data to Amazon Glacier. </para> </summary> <param name="vaultName">The name of the vault to download the archive from.</param> <param name="archiveDescription">A description for the archive.</param> <param name="filepath">The file path to the file to upload.</param> <param name="options">Additional options that can be used for the upload.</param> <returns>The results of the upload including the archive ID.</returns> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.Download(System.String,System.String,System.String)"> <summary> <para> Downloads an Amazon Glacier archive from the specified vault for the current user's account. Saves the archive to the specified file. </para> <para> This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin. </para> </summary> <param name="filePath">The file path to save the archive to.</param> <param name="vaultName">The name of the vault to download the archive from.</param> <param name="archiveId">The unique ID of the archive to download.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.Download(System.String,System.String,System.String,Amazon.Glacier.Transfer.DownloadOptions)"> <summary> <para> Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file. </para> <para> This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin. </para> <para> Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress. </para> </summary> <param name="filePath">The file path to save the archive at.</param> <param name="vaultName">The name of the vault to download the archive from.</param> <param name="archiveId">The unique ID of the archive to download.</param> <param name="options">Additional options that can be used for the download.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.DownloadJob(System.String,System.String,System.String)"> <summary> <para> Downloads the results from a completed archive retrieval. Saves the job output to the specified file. </para> <para> If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared. </para> </summary> <param name="vaultName">The name of the vault to download the job output from.</param> <param name="jobId">The unique job ID for an archive retrieval job.</param> <param name="filePath">The file path to save the job output at.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.DownloadJob(System.String,System.String,System.String,Amazon.Glacier.Transfer.DownloadOptions)"> <summary> <para> Downloads the results from a completed archive retrieval. Saves the job output to the specified file. </para> <para> If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared. </para> </summary> <param name="vaultName">The name of the vault to download the job output from.</param> <param name="jobId">The unique job ID for an archive retrieval job.</param> <param name="filePath">The file path to save the job output at.</param> <param name="options">Additional options that can be used for the download.</param> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.InitiateArchiveRetrievalJob(System.String,System.String)"> <summary> This method initiates an archive retieval job for the specified archive and returns back the job id. Once the is complete </summary> <param name="vaultName">The name of the vault that contains the archive to initiate the job for.</param> <param name="archiveId">The archive id that the download job will retrieve.</param> <returns>The job id for the initiated job.</returns> </member> <member name="M:Amazon.Glacier.Transfer.ArchiveTransferManager.InitiateArchiveRetrievalJob(System.String,System.String,Amazon.Glacier.Transfer.InitiateArchiveRetrievalOptions)"> <summary> This method initiates an archive retieval job for the specified archive and returns back the job id. Once the is complete </summary> <param name="vaultName">The name of the vault that contains the archive to initiate the job for.</param> <param name="archiveId">The archive id that the download job will retrieve.</param> <param name="options">Additional options that can be used for initiating archive retrieval.</param> <returns>The job id for the initiated job.</returns> </member> <member name="P:Amazon.Glacier.Transfer.ArchiveTransferManager.GlacierClient"> <summary> The Glacier client used by the ArchiveTransferManager. </summary> </member> <member name="T:Amazon.Glacier.Model.AbortMultipartUploadRequest"> <summary> Container for the parameters to the AbortMultipartUpload operation. <para>This operation aborts a multipart upload identified by the upload ID.</para> <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 UploadMultipartPart and CompleteMultipartUpload.</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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.AbortMultipartUpload(Amazon.Glacier.Model.AbortMultipartUploadRequest)"/> </member> <member name="M:Amazon.Glacier.Model.AbortMultipartUploadRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.AbortMultipartUploadRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.AbortMultipartUploadRequest.WithUploadId(System.String)"> <summary> Sets the UploadId property </summary> <param name="uploadId">The value to set for the UploadId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.AbortMultipartUploadRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.AbortMultipartUploadRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.AbortMultipartUploadRequest.UploadId"> <summary> The upload ID of the multipart upload to delete. </summary> </member> <member name="T:Amazon.Glacier.Model.AbortMultipartUploadResponse"> <summary> Returns information about the AbortMultipartUpload response metadata. The AbortMultipartUpload operation has a void result type. </summary> </member> <member name="T:Amazon.Glacier.Model.CompleteMultipartUploadRequest"> <summary> Container for the parameters to the CompleteMultipartUpload operation. <para>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 InitiateJob.</para> <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 ListParts 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.CompleteMultipartUpload(Amazon.Glacier.Model.CompleteMultipartUploadRequest)"/> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadRequest.WithUploadId(System.String)"> <summary> Sets the UploadId property </summary> <param name="uploadId">The value to set for the UploadId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadRequest.WithArchiveSize(System.String)"> <summary> Sets the ArchiveSize property </summary> <param name="archiveSize">The value to set for the ArchiveSize property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadRequest.WithChecksum(System.String)"> <summary> Sets the Checksum property </summary> <param name="checksum">The value to set for the Checksum property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadRequest.UploadId"> <summary> The upload ID of the multipart upload. </summary> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadRequest.ArchiveSize"> <summary> The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded. </summary> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadRequest.Checksum"> <summary> The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails. </summary> </member> <member name="T:Amazon.Glacier.Model.CompleteMultipartUploadResponse"> <summary> Returns information about the CompleteMultipartUploadResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadResponse.CompleteMultipartUploadResult"> <summary> Gets and sets the CompleteMultipartUploadResult property. Contains the Amazon Glacier response to your request. For information about the underlying REST API, go to Upload Archive. For conceptual information, go to Working with Archives in Amazon Glacier. </summary> </member> <member name="T:Amazon.Glacier.Model.CompleteMultipartUploadResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> <para>For information about the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html" >Upload Archive</a> . For conceptual information, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html" >Working with Archives in Amazon Glacier</a> .</para> </summary> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadResult.WithChecksum(System.String)"> <summary> Sets the Checksum property </summary> <param name="checksum">The value to set for the Checksum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.CompleteMultipartUploadResult.WithArchiveId(System.String)"> <summary> Sets the ArchiveId property </summary> <param name="archiveId">The value to set for the ArchiveId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadResult.Location"> <summary> The relative URI path of the newly added archive resource. </summary> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadResult.Checksum"> <summary> The checksum of the archive computed by Amazon Glacier. </summary> </member> <member name="P:Amazon.Glacier.Model.CompleteMultipartUploadResult.ArchiveId"> <summary> The ID of the archive. This value is also included as part of the location. </summary> </member> <member name="T:Amazon.Glacier.Model.CreateVaultRequest"> <summary> Container for the parameters to the CreateVault operation. <para>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> <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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.CreateVault(Amazon.Glacier.Model.CreateVaultRequest)"/> </member> <member name="M:Amazon.Glacier.Model.CreateVaultRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.CreateVaultRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.CreateVaultRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.CreateVaultRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.CreateVaultResponse"> <summary> Returns information about the CreateVaultResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.CreateVaultResponse.CreateVaultResult"> <summary> Gets and sets the CreateVaultResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.CreateVaultResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.CreateVaultResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.CreateVaultResult.Location"> <summary> The URI of the vault that was created. </summary> </member> <member name="T:Amazon.Glacier.Model.DeleteArchiveRequest"> <summary> Container for the parameters to the DeleteArchive operation. <para>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:</para> <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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteArchive(Amazon.Glacier.Model.DeleteArchiveRequest)"/> </member> <member name="M:Amazon.Glacier.Model.DeleteArchiveRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DeleteArchiveRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DeleteArchiveRequest.WithArchiveId(System.String)"> <summary> Sets the ArchiveId property </summary> <param name="archiveId">The value to set for the ArchiveId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DeleteArchiveRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.DeleteArchiveRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DeleteArchiveRequest.ArchiveId"> <summary> The ID of the archive to delete. </summary> </member> <member name="T:Amazon.Glacier.Model.DeleteArchiveResponse"> <summary> Returns information about the DeleteArchive response metadata. The DeleteArchive operation has a void result type. </summary> </member> <member name="T:Amazon.Glacier.Model.DeleteVaultNotificationsRequest"> <summary> Container for the parameters to the DeleteVaultNotifications operation. <para>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> <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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVaultNotifications(Amazon.Glacier.Model.DeleteVaultNotificationsRequest)"/> </member> <member name="M:Amazon.Glacier.Model.DeleteVaultNotificationsRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DeleteVaultNotificationsRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DeleteVaultNotificationsRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.DeleteVaultNotificationsRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.DeleteVaultNotificationsResponse"> <summary> Returns information about the DeleteVaultNotifications response metadata. The DeleteVaultNotifications operation has a void result type. </summary> </member> <member name="T:Amazon.Glacier.Model.DeleteVaultRequest"> <summary> Container for the parameters to the DeleteVault operation. <para>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 DescribeVault 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> <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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.DeleteVault(Amazon.Glacier.Model.DeleteVaultRequest)"/> </member> <member name="M:Amazon.Glacier.Model.DeleteVaultRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DeleteVaultRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DeleteVaultRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.DeleteVaultRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.DeleteVaultResponse"> <summary> Returns information about the DeleteVault response metadata. The DeleteVault operation has a void result type. </summary> </member> <member name="T:Amazon.Glacier.Model.DescribeJobRequest"> <summary> Container for the parameters to the DescribeJob operation. <para>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 InitiateJob. </para> <para><b>NOTE:</b> 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> <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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeJob(Amazon.Glacier.Model.DescribeJobRequest)"/> </member> <member name="M:Amazon.Glacier.Model.DescribeJobRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobRequest.WithJobId(System.String)"> <summary> Sets the JobId property </summary> <param name="jobId">The value to set for the JobId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DescribeJobRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobRequest.JobId"> <summary> The ID of the job to describe. </summary> </member> <member name="T:Amazon.Glacier.Model.DescribeJobResponse"> <summary> Returns information about the DescribeJobResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResponse.DescribeJobResult"> <summary> Gets and sets the DescribeJobResult property. Describes an Amazon Glacier job. </summary> </member> <member name="T:Amazon.Glacier.Model.DescribeJobResult"> <summary> <para>Describes an Amazon Glacier job.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithJobId(System.String)"> <summary> Sets the JobId property </summary> <param name="jobId">The value to set for the JobId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithJobDescription(System.String)"> <summary> Sets the JobDescription property </summary> <param name="jobDescription">The value to set for the JobDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithAction(System.String)"> <summary> Sets the Action property </summary> <param name="action">The value to set for the Action property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithArchiveId(System.String)"> <summary> Sets the ArchiveId property </summary> <param name="archiveId">The value to set for the ArchiveId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithVaultARN(System.String)"> <summary> Sets the VaultARN property </summary> <param name="vaultARN">The value to set for the VaultARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithCreationDate(System.DateTime)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithCompleted(System.Boolean)"> <summary> Sets the Completed property </summary> <param name="completed">The value to set for the Completed property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithStatusCode(System.String)"> <summary> Sets the StatusCode property </summary> <param name="statusCode">The value to set for the StatusCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithStatusMessage(System.String)"> <summary> Sets the StatusMessage property </summary> <param name="statusMessage">The value to set for the StatusMessage property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithArchiveSizeInBytes(System.Int64)"> <summary> Sets the ArchiveSizeInBytes property </summary> <param name="archiveSizeInBytes">The value to set for the ArchiveSizeInBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithInventorySizeInBytes(System.Int64)"> <summary> Sets the InventorySizeInBytes property </summary> <param name="inventorySizeInBytes">The value to set for the InventorySizeInBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithSNSTopic(System.String)"> <summary> Sets the SNSTopic property </summary> <param name="sNSTopic">The value to set for the SNSTopic property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithCompletionDate(System.DateTime)"> <summary> Sets the CompletionDate property </summary> <param name="completionDate">The value to set for the CompletionDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithSHA256TreeHash(System.String)"> <summary> Sets the SHA256TreeHash property </summary> <param name="sHA256TreeHash">The value to set for the SHA256TreeHash property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithArchiveSHA256TreeHash(System.String)"> <summary> Sets the ArchiveSHA256TreeHash property </summary> <param name="archiveSHA256TreeHash">The value to set for the ArchiveSHA256TreeHash property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithRetrievalByteRange(System.String)"> <summary> Sets the RetrievalByteRange property </summary> <param name="retrievalByteRange">The value to set for the RetrievalByteRange property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeJobResult.WithInventoryRetrievalParameters(Amazon.Glacier.Model.InventoryRetrievalJobDescription)"> <summary> Sets the InventoryRetrievalParameters property </summary> <param name="inventoryRetrievalParameters">The value to set for the InventoryRetrievalParameters property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.JobId"> <summary> An opaque string that identifies an Amazon Glacier job. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.JobDescription"> <summary> The job description you provided when you initiated the job. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.Action"> <summary> The job type. It is either ArchiveRetrieval or InventoryRetrieval. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ArchiveRetrieval, InventoryRetrieval</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.ArchiveId"> <summary> For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.VaultARN"> <summary> The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.CreationDate"> <summary> The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.Completed"> <summary> The job status. When a job is completed, you get the job's output. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.StatusCode"> <summary> The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>InProgress, Succeeded, Failed</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.StatusMessage"> <summary> A friendly message that describes the job status. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.ArchiveSizeInBytes"> <summary> For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.InventorySizeInBytes"> <summary> For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.SNSTopic"> <summary> An Amazon Simple Notification Service (Amazon SNS) topic that receives notification. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.CompletionDate"> <summary> The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.SHA256TreeHash"> <summary> For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null. The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value. For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This field is null in the following situations: <ul> <li>Archive retrieval jobs that specify a range that is not tree-hash aligned.</li> </ul> <ul> <li>Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.</li> </ul> <ul> <li>Inventory jobs.</li> </ul> </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.ArchiveSHA256TreeHash"> <summary> The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.RetrievalByteRange"> <summary> The retrieved byte range for archive retrieval jobs in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If no range was specified in the archive retrieval, then the whole archive is retrieved and <i>StartByteValue</i> equals 0 and <i>EndByteValue</i> equals the size of the archive minus 1. For inventory retrieval jobs this field is null. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeJobResult.InventoryRetrievalParameters"> <summary> Parameters used for range inventory retrieval. </summary> </member> <member name="T:Amazon.Glacier.Model.DescribeVaultOutput"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultOutput.WithVaultARN(System.String)"> <summary> Sets the VaultARN property </summary> <param name="vaultARN">The value to set for the VaultARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultOutput.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultOutput.WithCreationDate(System.DateTime)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultOutput.WithLastInventoryDate(System.DateTime)"> <summary> Sets the LastInventoryDate property </summary> <param name="lastInventoryDate">The value to set for the LastInventoryDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultOutput.WithNumberOfArchives(System.Int64)"> <summary> Sets the NumberOfArchives property </summary> <param name="numberOfArchives">The value to set for the NumberOfArchives property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultOutput.WithSizeInBytes(System.Int64)"> <summary> Sets the SizeInBytes property </summary> <param name="sizeInBytes">The value to set for the SizeInBytes property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultOutput.VaultARN"> <summary> The Amazon Resource Name (ARN) of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultOutput.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultOutput.CreationDate"> <summary> The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultOutput.LastInventoryDate"> <summary> The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultOutput.NumberOfArchives"> <summary> The number of archives in the vault as of the last inventory date. This field will return <c>null</c> if an inventory has not yet run on the vault, for example, if you just created the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultOutput.SizeInBytes"> <summary> Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.DescribeVaultRequest"> <summary> Container for the parameters to the DescribeVault operation. <para>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 InitiateJob. 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> <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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.DescribeVault(Amazon.Glacier.Model.DescribeVaultRequest)"/> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.DescribeVaultResponse"> <summary> Returns information about the DescribeVaultResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultResponse.DescribeVaultResult"> <summary> Gets and sets the DescribeVaultResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.DescribeVaultResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultResult.WithVaultARN(System.String)"> <summary> Sets the VaultARN property </summary> <param name="vaultARN">The value to set for the VaultARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultResult.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultResult.WithCreationDate(System.String)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultResult.WithLastInventoryDate(System.String)"> <summary> Sets the LastInventoryDate property </summary> <param name="lastInventoryDate">The value to set for the LastInventoryDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultResult.WithNumberOfArchives(System.Int64)"> <summary> Sets the NumberOfArchives property </summary> <param name="numberOfArchives">The value to set for the NumberOfArchives property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.DescribeVaultResult.WithSizeInBytes(System.Int64)"> <summary> Sets the SizeInBytes property </summary> <param name="sizeInBytes">The value to set for the SizeInBytes property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultResult.VaultARN"> <summary> The Amazon Resource Name (ARN) of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultResult.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultResult.CreationDate"> <summary> The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultResult.LastInventoryDate"> <summary> The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultResult.NumberOfArchives"> <summary> The number of archives in the vault as of the last inventory date. This field will return <c>null</c> if an inventory has not yet run on the vault, for example, if you just created the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.DescribeVaultResult.SizeInBytes"> <summary> Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.GetJobOutputRequest"> <summary> Container for the parameters to the GetJobOutput operation. <para>This operation downloads the output of the job you initiated using InitiateJob. 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> <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 <c>Range</c> 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 <c>Range</c> header.</para> </li> <li> <para>Along with the data, the response includes a checksum 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 DescribeJob 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetJobOutput(Amazon.Glacier.Model.GetJobOutputRequest)"/> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputRequest.WithJobId(System.String)"> <summary> Sets the JobId property </summary> <param name="jobId">The value to set for the JobId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputRequest.WithRange(System.String)"> <summary> Sets the Range property </summary> <param name="range">The value to set for the Range property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputRequest.JobId"> <summary> The job ID whose data is downloaded. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputRequest.Range"> <summary> The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output. </summary> </member> <member name="T:Amazon.Glacier.Model.GetJobOutputResponse"> <summary> Returns information about the GetJobOutputResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResponse.GetJobOutputResult"> <summary> Gets and sets the GetJobOutputResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.GetJobOutputResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputResult.WithBody(System.IO.Stream)"> <summary> Sets the Body property </summary> <param name="body">The value to set for the Body property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputResult.WithChecksum(System.String)"> <summary> Sets the Checksum property </summary> <param name="checksum">The value to set for the Checksum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputResult.WithStatus(System.Int32)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputResult.WithContentRange(System.String)"> <summary> Sets the ContentRange property </summary> <param name="contentRange">The value to set for the ContentRange property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputResult.WithAcceptRanges(System.String)"> <summary> Sets the AcceptRanges property </summary> <param name="acceptRanges">The value to set for the AcceptRanges property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputResult.WithContentType(System.String)"> <summary> Sets the ContentType property </summary> <param name="contentType">The value to set for the ContentType property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetJobOutputResult.WithArchiveDescription(System.String)"> <summary> Sets the ArchiveDescription property </summary> <param name="archiveDescription">The value to set for the ArchiveDescription property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResult.Body"> <summary> The job data, either archive data or inventory data. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResult.Checksum"> <summary> The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions: <ul> <li>You get the entire range of the archive.</li> <li>You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.</li> <li>You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.</li> </ul> </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResult.Status"> <summary> The HTTP response code for a job output request. The value depends on whether a range was specified in the request. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResult.ContentRange"> <summary> The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResult.AcceptRanges"> <summary> Indicates the range units accepted. For more information, go to <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">RFC2616</a>. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResult.ContentType"> <summary> The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json. </summary> </member> <member name="P:Amazon.Glacier.Model.GetJobOutputResult.ArchiveDescription"> <summary> The description of an archive. </summary> </member> <member name="T:Amazon.Glacier.Model.GetVaultNotificationsRequest"> <summary> Container for the parameters to the GetVaultNotifications operation. <para>This operation retrieves the <c>notification-configuration</c> subresource of the specified vault.</para> <para>For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a <c>404 Not Found</c> 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.GetVaultNotifications(Amazon.Glacier.Model.GetVaultNotificationsRequest)"/> </member> <member name="M:Amazon.Glacier.Model.GetVaultNotificationsRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GetVaultNotificationsRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.GetVaultNotificationsRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.GetVaultNotificationsRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.GetVaultNotificationsResponse"> <summary> Returns information about the GetVaultNotificationsResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.GetVaultNotificationsResponse.GetVaultNotificationsResult"> <summary> Gets and sets the GetVaultNotificationsResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.GetVaultNotificationsResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.GetVaultNotificationsResult.WithVaultNotificationConfig(Amazon.Glacier.Model.VaultNotificationConfig)"> <summary> Sets the VaultNotificationConfig property </summary> <param name="vaultNotificationConfig">The value to set for the VaultNotificationConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.GetVaultNotificationsResult.VaultNotificationConfig"> <summary> Returns the notification configuration set on the vault. </summary> </member> <member name="T:Amazon.Glacier.Model.GlacierJobDescription"> <summary> <para>Describes an Amazon Glacier job.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithJobId(System.String)"> <summary> Sets the JobId property </summary> <param name="jobId">The value to set for the JobId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithJobDescription(System.String)"> <summary> Sets the JobDescription property </summary> <param name="jobDescription">The value to set for the JobDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithAction(System.String)"> <summary> Sets the Action property </summary> <param name="action">The value to set for the Action property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithArchiveId(System.String)"> <summary> Sets the ArchiveId property </summary> <param name="archiveId">The value to set for the ArchiveId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithVaultARN(System.String)"> <summary> Sets the VaultARN property </summary> <param name="vaultARN">The value to set for the VaultARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithCreationDate(System.DateTime)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithCompleted(System.Boolean)"> <summary> Sets the Completed property </summary> <param name="completed">The value to set for the Completed property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithStatusCode(System.String)"> <summary> Sets the StatusCode property </summary> <param name="statusCode">The value to set for the StatusCode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithStatusMessage(System.String)"> <summary> Sets the StatusMessage property </summary> <param name="statusMessage">The value to set for the StatusMessage property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithArchiveSizeInBytes(System.Int64)"> <summary> Sets the ArchiveSizeInBytes property </summary> <param name="archiveSizeInBytes">The value to set for the ArchiveSizeInBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithInventorySizeInBytes(System.Int64)"> <summary> Sets the InventorySizeInBytes property </summary> <param name="inventorySizeInBytes">The value to set for the InventorySizeInBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithSNSTopic(System.String)"> <summary> Sets the SNSTopic property </summary> <param name="sNSTopic">The value to set for the SNSTopic property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithCompletionDate(System.DateTime)"> <summary> Sets the CompletionDate property </summary> <param name="completionDate">The value to set for the CompletionDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithSHA256TreeHash(System.String)"> <summary> Sets the SHA256TreeHash property </summary> <param name="sHA256TreeHash">The value to set for the SHA256TreeHash property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithArchiveSHA256TreeHash(System.String)"> <summary> Sets the ArchiveSHA256TreeHash property </summary> <param name="archiveSHA256TreeHash">The value to set for the ArchiveSHA256TreeHash property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithRetrievalByteRange(System.String)"> <summary> Sets the RetrievalByteRange property </summary> <param name="retrievalByteRange">The value to set for the RetrievalByteRange property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.GlacierJobDescription.WithInventoryRetrievalParameters(Amazon.Glacier.Model.InventoryRetrievalJobDescription)"> <summary> Sets the InventoryRetrievalParameters property </summary> <param name="inventoryRetrievalParameters">The value to set for the InventoryRetrievalParameters property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.JobId"> <summary> An opaque string that identifies an Amazon Glacier job. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.JobDescription"> <summary> The job description you provided when you initiated the job. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.Action"> <summary> The job type. It is either ArchiveRetrieval or InventoryRetrieval. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>ArchiveRetrieval, InventoryRetrieval</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.ArchiveId"> <summary> For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.VaultARN"> <summary> The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.CreationDate"> <summary> The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z". </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.Completed"> <summary> The job status. When a job is completed, you get the job's output. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.StatusCode"> <summary> The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Allowed Values</term> <description>InProgress, Succeeded, Failed</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.StatusMessage"> <summary> A friendly message that describes the job status. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.ArchiveSizeInBytes"> <summary> For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.InventorySizeInBytes"> <summary> For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.SNSTopic"> <summary> An Amazon Simple Notification Service (Amazon SNS) topic that receives notification. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.CompletionDate"> <summary> The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.SHA256TreeHash"> <summary> For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null. The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value. For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This field is null in the following situations: <ul> <li>Archive retrieval jobs that specify a range that is not tree-hash aligned.</li> </ul> <ul> <li>Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.</li> </ul> <ul> <li>Inventory jobs.</li> </ul> </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.ArchiveSHA256TreeHash"> <summary> The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.RetrievalByteRange"> <summary> The retrieved byte range for archive retrieval jobs in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If no range was specified in the archive retrieval, then the whole archive is retrieved and <i>StartByteValue</i> equals 0 and <i>EndByteValue</i> equals the size of the archive minus 1. For inventory retrieval jobs this field is null. </summary> </member> <member name="P:Amazon.Glacier.Model.GlacierJobDescription.InventoryRetrievalParameters"> <summary> Parameters used for range inventory retrieval. </summary> </member> <member name="T:Amazon.Glacier.Model.InitiateJobRequest"> <summary> Container for the parameters to the InitiateJob operation. <para>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> <para>Retrieving data from Amazon Glacier is a two-step process: </para> <ol> <li> <para>Initiate a retrieval job.</para> </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 GetJobOutput 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 SetVaultNotifications.</para> </li> <li> <para> <b>Get job details</b> You can make a DescribeJob 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> <para><b>NOTE:</b> The information you get via notification is same that you get by calling DescribeJob. </para> <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 SetVaultNotifications.</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 <c>StartDate</c> and <c>EndDate</c> by specifying values for these parameters in the <b>InitiateJob</b> request. Archives created on or after the <c>StartDate</c> and before the <c>EndDate</c> will be returned. If you only provide the <c>StartDate</c> without the <c>EndDate</c> , you will retrieve the inventory for all archives created on or after the <c>StartDate</c> . If you only provide the <c>EndDate</c> without the <c>StartDate</c> , you will get back the inventory for all archives created before the <c>EndDate</c> .</para> <para> <i>Limiting Inventory Items per Retrieval</i> </para> <para>You can limit the number of inventory items returned by setting the <c>Limit</c> parameter in the <b>InitiateJob</b> request. The inventory job output will contain inventory items up to the specified <c>Limit</c> . If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob 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 <c>Limit</c> 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateJob(Amazon.Glacier.Model.InitiateJobRequest)"/> </member> <member name="M:Amazon.Glacier.Model.InitiateJobRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InitiateJobRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InitiateJobRequest.WithJobParameters(Amazon.Glacier.Model.JobParameters)"> <summary> Sets the JobParameters property </summary> <param name="jobParameters">The value to set for the JobParameters property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.InitiateJobRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateJobRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateJobRequest.JobParameters"> <summary> Provides options for specifying job information. </summary> </member> <member name="T:Amazon.Glacier.Model.InitiateJobResponse"> <summary> Returns information about the InitiateJobResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateJobResponse.InitiateJobResult"> <summary> Gets and sets the InitiateJobResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.InitiateJobResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.InitiateJobResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InitiateJobResult.WithJobId(System.String)"> <summary> Sets the JobId property </summary> <param name="jobId">The value to set for the JobId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.InitiateJobResult.Location"> <summary> The relative URI path of the job. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateJobResult.JobId"> <summary> The ID of the job. </summary> </member> <member name="T:Amazon.Glacier.Model.InitiateMultipartUploadRequest"> <summary> Container for the parameters to the InitiateMultipartUpload operation. <para>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 UploadMultipartPart).</para> <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 UploadMultipartPart), 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> <para><b>NOTE:</b> 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> <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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.InitiateMultipartUpload(Amazon.Glacier.Model.InitiateMultipartUploadRequest)"/> </member> <member name="M:Amazon.Glacier.Model.InitiateMultipartUploadRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InitiateMultipartUploadRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InitiateMultipartUploadRequest.WithArchiveDescription(System.String)"> <summary> Sets the ArchiveDescription property </summary> <param name="archiveDescription">The value to set for the ArchiveDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InitiateMultipartUploadRequest.WithPartSize(System.Int64)"> <summary> Sets the PartSize property </summary> <param name="partSize">The value to set for the PartSize property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.InitiateMultipartUploadRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateMultipartUploadRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateMultipartUploadRequest.ArchiveDescription"> <summary> The archive description that you are uploading in parts. 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 (4096 MB). </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateMultipartUploadRequest.PartSize"> <summary> The size of each part except the last, in bytes. The last part can be smaller than this part size. </summary> </member> <member name="T:Amazon.Glacier.Model.InitiateMultipartUploadResponse"> <summary> Returns information about the InitiateMultipartUploadResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateMultipartUploadResponse.InitiateMultipartUploadResult"> <summary> Gets and sets the InitiateMultipartUploadResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.InitiateMultipartUploadResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.InitiateMultipartUploadResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.InitiateMultipartUploadResult.WithUploadId(System.String)"> <summary> Sets the UploadId property </summary> <param name="uploadId">The value to set for the UploadId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.InitiateMultipartUploadResult.Location"> <summary> The relative URI path of the multipart upload ID Amazon Glacier created. </summary> </member> <member name="P:Amazon.Glacier.Model.InitiateMultipartUploadResult.UploadId"> <summary> The ID of the multipart upload. This value is also included as part of the location. </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.AbortMultipartUploadRequestMarshaller"> <summary> Abort Multipart Upload Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.AbortMultipartUploadResponseUnmarshaller"> <summary> Response Unmarshaller for AbortMultipartUpload operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.CompleteMultipartUploadRequestMarshaller"> <summary> Complete Multipart Upload Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.CompleteMultipartUploadResponseUnmarshaller"> <summary> Response Unmarshaller for CompleteMultipartUpload operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.CompleteMultipartUploadResultUnmarshaller"> <summary> CompleteMultipartUploadResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.CreateVaultRequestMarshaller"> <summary> Create Vault Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.CreateVaultResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVault operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.CreateVaultResultUnmarshaller"> <summary> CreateVaultResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DeleteArchiveRequestMarshaller"> <summary> Delete Archive Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DeleteArchiveResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteArchive operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DeleteVaultNotificationsRequestMarshaller"> <summary> Delete Vault Notifications Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DeleteVaultNotificationsResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVaultNotifications operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DeleteVaultRequestMarshaller"> <summary> Delete Vault Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DeleteVaultResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVault operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DescribeJobRequestMarshaller"> <summary> Describe Job Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DescribeJobResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeJob operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DescribeJobResultUnmarshaller"> <summary> DescribeJobResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DescribeVaultOutputUnmarshaller"> <summary> DescribeVaultOutputUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DescribeVaultRequestMarshaller"> <summary> Describe Vault Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DescribeVaultResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVault operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.DescribeVaultResultUnmarshaller"> <summary> DescribeVaultResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.GetJobOutputRequestMarshaller"> <summary> Get Job Output Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.GetJobOutputResponseUnmarshaller"> <summary> Response Unmarshaller for GetJobOutput operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.GetJobOutputResultUnmarshaller"> <summary> GetJobOutputResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.GetVaultNotificationsRequestMarshaller"> <summary> Get Vault Notifications Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.GetVaultNotificationsResponseUnmarshaller"> <summary> Response Unmarshaller for GetVaultNotifications operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.GetVaultNotificationsResultUnmarshaller"> <summary> GetVaultNotificationsResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.GlacierJobDescriptionUnmarshaller"> <summary> GlacierJobDescriptionUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.InitiateJobRequestMarshaller"> <summary> Initiate Job Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.InitiateJobResponseUnmarshaller"> <summary> Response Unmarshaller for InitiateJob operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.InitiateJobResultUnmarshaller"> <summary> InitiateJobResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.InitiateMultipartUploadRequestMarshaller"> <summary> Initiate Multipart Upload Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.InitiateMultipartUploadResponseUnmarshaller"> <summary> Response Unmarshaller for InitiateMultipartUpload operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.InitiateMultipartUploadResultUnmarshaller"> <summary> InitiateMultipartUploadResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListJobsRequestMarshaller"> <summary> List Jobs Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListJobsResponseUnmarshaller"> <summary> Response Unmarshaller for ListJobs operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListJobsResultUnmarshaller"> <summary> ListJobsResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListMultipartUploadsRequestMarshaller"> <summary> List Multipart Uploads Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListMultipartUploadsResponseUnmarshaller"> <summary> Response Unmarshaller for ListMultipartUploads operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListMultipartUploadsResultUnmarshaller"> <summary> ListMultipartUploadsResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListPartsRequestMarshaller"> <summary> List Parts Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListPartsResponseUnmarshaller"> <summary> Response Unmarshaller for ListParts operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListPartsResultUnmarshaller"> <summary> ListPartsResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListVaultsRequestMarshaller"> <summary> List Vaults Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListVaultsResponseUnmarshaller"> <summary> Response Unmarshaller for ListVaults operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.ListVaultsResultUnmarshaller"> <summary> ListVaultsResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.PartListElementUnmarshaller"> <summary> PartListElementUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.SetVaultNotificationsRequestMarshaller"> <summary> Set Vault Notifications Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.SetVaultNotificationsResponseUnmarshaller"> <summary> Response Unmarshaller for SetVaultNotifications operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.UploadArchiveRequestMarshaller"> <summary> Upload Archive Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.UploadArchiveResponseUnmarshaller"> <summary> Response Unmarshaller for UploadArchive operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.UploadArchiveResultUnmarshaller"> <summary> UploadArchiveResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.UploadListElementUnmarshaller"> <summary> UploadListElementUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.UploadMultipartPartRequestMarshaller"> <summary> Upload Multipart Part Request Marshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.UploadMultipartPartResponseUnmarshaller"> <summary> Response Unmarshaller for UploadMultipartPart operation </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.UploadMultipartPartResultUnmarshaller"> <summary> UploadMultipartPartResultUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.Internal.MarshallTransformations.VaultNotificationConfigUnmarshaller"> <summary> VaultNotificationConfigUnmarshaller </summary> </member> <member name="T:Amazon.Glacier.Model.InvalidParameterValueException"> <summary> AmazonGlacier exception </summary> </member> <member name="M:Amazon.Glacier.Model.InvalidParameterValueException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterValueException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.Glacier.Model.JobParameters"> <summary> <para>Provides options for defining a job.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.JobParameters.WithFormat(System.String)"> <summary> Sets the Format property </summary> <param name="format">The value to set for the Format property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.JobParameters.WithType(System.String)"> <summary> Sets the Type property </summary> <param name="type">The value to set for the Type property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.JobParameters.WithArchiveId(System.String)"> <summary> Sets the ArchiveId property </summary> <param name="archiveId">The value to set for the ArchiveId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.JobParameters.WithDescription(System.String)"> <summary> Sets the Description property </summary> <param name="description">The value to set for the Description property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.JobParameters.WithSNSTopic(System.String)"> <summary> Sets the SNSTopic property </summary> <param name="sNSTopic">The value to set for the SNSTopic property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.JobParameters.WithRetrievalByteRange(System.String)"> <summary> Sets the RetrievalByteRange property </summary> <param name="retrievalByteRange">The value to set for the RetrievalByteRange property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.JobParameters.WithInventoryRetrievalParameters(Amazon.Glacier.Model.InventoryRetrievalJobInput)"> <summary> Sets the InventoryRetrievalParameters property </summary> <param name="inventoryRetrievalParameters">The value to set for the InventoryRetrievalParameters property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.JobParameters.Format"> <summary> When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON". </summary> </member> <member name="P:Amazon.Glacier.Model.JobParameters.Type"> <summary> The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are "archive-retrieval" and "inventory-retrieval". </summary> </member> <member name="P:Amazon.Glacier.Model.JobParameters.ArchiveId"> <summary> The ID of the archive that you want to retrieve. This field is required only if <c>Type</c> is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request. </summary> </member> <member name="P:Amazon.Glacier.Model.JobParameters.Description"> <summary> The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal. </summary> </member> <member name="P:Amazon.Glacier.Model.JobParameters.SNSTopic"> <summary> The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist. </summary> </member> <member name="P:Amazon.Glacier.Model.JobParameters.RetrievalByteRange"> <summary> The byte range to retrieve for an archive retrieval. in the form "<i>StartByteValue</i>-<i>EndByteValue</i>" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that <i>StartByteValue</i> must be divisible by 1 MB and <i>EndByteValue</i> plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response. An error occurs if you specify this field for an inventory retrieval job request. </summary> </member> <member name="P:Amazon.Glacier.Model.JobParameters.InventoryRetrievalParameters"> <summary> Input parameters used for range inventory retrieval. </summary> </member> <member name="T:Amazon.Glacier.Model.LimitExceededException"> <summary> AmazonGlacier exception </summary> </member> <member name="M:Amazon.Glacier.Model.LimitExceededException.#ctor(System.String)"> <summary> Constructs a new LimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.Glacier.Model.ListJobsRequest"> <summary> Container for the parameters to the ListJobs operation. <para>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. </para> <para><b>NOTE:</b> 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> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of jobs that begins at a specific job, set the <c>marker</c> 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 <c>limit</c> parameter in the request.</para> <para>Additionally, you can filter the jobs list returned by specifying an optional <c>statuscode</c> (InProgress, Succeeded, or Failed) and <c>completed</c> (true, false) parameter. The <c>statuscode</c> allows you to specify that only jobs that match a specified status are returned. The <c>completed</c> 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListJobs(Amazon.Glacier.Model.ListJobsRequest)"/> </member> <member name="M:Amazon.Glacier.Model.ListJobsRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListJobsRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListJobsRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListJobsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListJobsRequest.WithStatuscode(System.String)"> <summary> Sets the Statuscode property </summary> <param name="statuscode">The value to set for the Statuscode property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListJobsRequest.WithCompleted(System.Boolean)"> <summary> Sets the Completed property </summary> <param name="completed">The value to set for the Completed property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListJobsRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.ListJobsRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.ListJobsRequest.Limit"> <summary> Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs. </summary> </member> <member name="P:Amazon.Glacier.Model.ListJobsRequest.Marker"> <summary> An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request. </summary> </member> <member name="P:Amazon.Glacier.Model.ListJobsRequest.Statuscode"> <summary> Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed". </summary> </member> <member name="P:Amazon.Glacier.Model.ListJobsRequest.Completed"> <summary> Specifies the state of the jobs to return. You can specify <c>true</c> or <c>false</c>. </summary> </member> <member name="T:Amazon.Glacier.Model.ListJobsResponse"> <summary> Returns information about the ListJobsResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.ListJobsResponse.ListJobsResult"> <summary> Gets and sets the ListJobsResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.ListJobsResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.ListJobsResult.WithJobList(Amazon.Glacier.Model.GlacierJobDescription[])"> <summary> Adds elements to the JobList collection </summary> <param name="jobList">The values to add to the JobList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListJobsResult.WithJobList(System.Collections.Generic.IEnumerable{Amazon.Glacier.Model.GlacierJobDescription})"> <summary> Adds elements to the JobList collection </summary> <param name="jobList">The values to add to the JobList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListJobsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListJobsResult.JobList"> <summary> A list of job objects. Each job object contains metadata describing the job. </summary> </member> <member name="P:Amazon.Glacier.Model.ListJobsResult.Marker"> <summary> An opaque string that represents where to continue pagination of the results. You use this value in a new List Jobs request to obtain more jobs in the list. If there are no more jobs, this value is <c>null</c>. </summary> </member> <member name="T:Amazon.Glacier.Model.ListMultipartUploadsRequest"> <summary> Container for the parameters to the ListMultipartUploads operation. <para>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 InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. </para> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of multipart uploads that begins at a specific upload, set the <c>marker</c> 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 <c>limit</c> parameter in the request.</para> <para>Note the difference between this operation and listing parts (ListParts). 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListMultipartUploads(Amazon.Glacier.Model.ListMultipartUploadsRequest)"/> </member> <member name="M:Amazon.Glacier.Model.ListMultipartUploadsRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListMultipartUploadsRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListMultipartUploadsRequest.WithUploadIdMarker(System.String)"> <summary> Sets the UploadIdMarker property </summary> <param name="uploadIdMarker">The value to set for the UploadIdMarker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListMultipartUploadsRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListMultipartUploadsRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.ListMultipartUploadsRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.ListMultipartUploadsRequest.UploadIdMarker"> <summary> An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request. </summary> </member> <member name="P:Amazon.Glacier.Model.ListMultipartUploadsRequest.Limit"> <summary> Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads. </summary> </member> <member name="T:Amazon.Glacier.Model.ListMultipartUploadsResponse"> <summary> Returns information about the ListMultipartUploadsResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.ListMultipartUploadsResponse.ListMultipartUploadsResult"> <summary> Gets and sets the ListMultipartUploadsResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.ListMultipartUploadsResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.ListMultipartUploadsResult.WithUploadsList(Amazon.Glacier.Model.UploadListElement[])"> <summary> Adds elements to the UploadsList collection </summary> <param name="uploadsList">The values to add to the UploadsList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListMultipartUploadsResult.WithUploadsList(System.Collections.Generic.IEnumerable{Amazon.Glacier.Model.UploadListElement})"> <summary> Adds elements to the UploadsList collection </summary> <param name="uploadsList">The values to add to the UploadsList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListMultipartUploadsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListMultipartUploadsResult.UploadsList"> <summary> A list of in-progress multipart uploads. </summary> </member> <member name="P:Amazon.Glacier.Model.ListMultipartUploadsResult.Marker"> <summary> An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is <c>null</c>. </summary> </member> <member name="T:Amazon.Glacier.Model.ListPartsRequest"> <summary> Container for the parameters to the ListParts operation. <para>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 CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. </para> <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 <c>marker</c> at which to continue the list; if there are no more items the <c>marker</c> is <c>null</c> . To return a list of parts that begins at a specific part, set the <c>marker</c> 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 <c>limit</c> 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListParts(Amazon.Glacier.Model.ListPartsRequest)"/> </member> <member name="M:Amazon.Glacier.Model.ListPartsRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsRequest.WithUploadId(System.String)"> <summary> Sets the UploadId property </summary> <param name="uploadId">The value to set for the UploadId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListPartsRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsRequest.UploadId"> <summary> The upload ID of the multipart upload. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsRequest.Marker"> <summary> An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsRequest.Limit"> <summary> Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads. </summary> </member> <member name="T:Amazon.Glacier.Model.ListPartsResponse"> <summary> Returns information about the ListPartsResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsResponse.ListPartsResult"> <summary> Gets and sets the ListPartsResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.ListPartsResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithMultipartUploadId(System.String)"> <summary> Sets the MultipartUploadId property </summary> <param name="multipartUploadId">The value to set for the MultipartUploadId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithVaultARN(System.String)"> <summary> Sets the VaultARN property </summary> <param name="vaultARN">The value to set for the VaultARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithArchiveDescription(System.String)"> <summary> Sets the ArchiveDescription property </summary> <param name="archiveDescription">The value to set for the ArchiveDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithPartSizeInBytes(System.Int64)"> <summary> Sets the PartSizeInBytes property </summary> <param name="partSizeInBytes">The value to set for the PartSizeInBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithCreationDate(System.DateTime)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithParts(Amazon.Glacier.Model.PartListElement[])"> <summary> Adds elements to the Parts collection </summary> <param name="parts">The values to add to the Parts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithParts(System.Collections.Generic.IEnumerable{Amazon.Glacier.Model.PartListElement})"> <summary> Adds elements to the Parts collection </summary> <param name="parts">The values to add to the Parts collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListPartsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListPartsResult.MultipartUploadId"> <summary> The ID of the upload to which the parts are associated. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsResult.VaultARN"> <summary> The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsResult.ArchiveDescription"> <summary> The description of the archive that was specified in the Initiate Multipart Upload request. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsResult.PartSizeInBytes"> <summary> The part size in bytes. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsResult.CreationDate"> <summary> The UTC time at which the multipart upload was initiated. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsResult.Parts"> <summary> A list of the part sizes of the multipart upload. </summary> </member> <member name="P:Amazon.Glacier.Model.ListPartsResult.Marker"> <summary> An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is <c>null</c>. </summary> </member> <member name="T:Amazon.Glacier.Model.ListVaultsRequest"> <summary> Container for the parameters to the ListVaults operation. <para>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> <para>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <c>marker</c> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <c>marker</c> field is <c>null</c> . To return a list of vaults that begins at a specific vault, set the <c>marker</c> 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 <c>limit</c> 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.ListVaults(Amazon.Glacier.Model.ListVaultsRequest)"/> </member> <member name="M:Amazon.Glacier.Model.ListVaultsRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListVaultsRequest.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListVaultsRequest.WithLimit(System.Int32)"> <summary> Sets the Limit property </summary> <param name="limit">The value to set for the Limit property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListVaultsRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.ListVaultsRequest.Marker"> <summary> A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin. </summary> </member> <member name="P:Amazon.Glacier.Model.ListVaultsRequest.Limit"> <summary> The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items. </summary> </member> <member name="T:Amazon.Glacier.Model.ListVaultsResponse"> <summary> Returns information about the ListVaultsResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.ListVaultsResponse.ListVaultsResult"> <summary> Gets and sets the ListVaultsResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.ListVaultsResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.ListVaultsResult.WithVaultList(Amazon.Glacier.Model.DescribeVaultOutput[])"> <summary> Adds elements to the VaultList collection </summary> <param name="vaultList">The values to add to the VaultList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListVaultsResult.WithVaultList(System.Collections.Generic.IEnumerable{Amazon.Glacier.Model.DescribeVaultOutput})"> <summary> Adds elements to the VaultList collection </summary> <param name="vaultList">The values to add to the VaultList collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.ListVaultsResult.WithMarker(System.String)"> <summary> Sets the Marker property </summary> <param name="marker">The value to set for the Marker property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.ListVaultsResult.VaultList"> <summary> List of vaults. </summary> </member> <member name="P:Amazon.Glacier.Model.ListVaultsResult.Marker"> <summary> The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list. </summary> </member> <member name="T:Amazon.Glacier.Model.MissingParameterValueException"> <summary> AmazonGlacier exception </summary> </member> <member name="M:Amazon.Glacier.Model.MissingParameterValueException.#ctor(System.String)"> <summary> Constructs a new MissingParameterValueException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.Glacier.Model.PartListElement"> <summary> <para>A list of the part sizes of the multipart upload.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.PartListElement.WithRangeInBytes(System.String)"> <summary> Sets the RangeInBytes property </summary> <param name="rangeInBytes">The value to set for the RangeInBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.PartListElement.WithSHA256TreeHash(System.String)"> <summary> Sets the SHA256TreeHash property </summary> <param name="sHA256TreeHash">The value to set for the SHA256TreeHash property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.PartListElement.RangeInBytes"> <summary> The byte range of a part, inclusive of the upper value of the range. </summary> </member> <member name="P:Amazon.Glacier.Model.PartListElement.SHA256TreeHash"> <summary> The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never <c>null</c>. </summary> </member> <member name="T:Amazon.Glacier.Model.RequestTimeoutException"> <summary> AmazonGlacier exception </summary> </member> <member name="M:Amazon.Glacier.Model.RequestTimeoutException.#ctor(System.String)"> <summary> Constructs a new RequestTimeoutException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.Glacier.Model.ResourceNotFoundException"> <summary> AmazonGlacier exception </summary> </member> <member name="M:Amazon.Glacier.Model.ResourceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ResourceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.Glacier.Model.ServiceUnavailableException"> <summary> AmazonGlacier exception </summary> </member> <member name="M:Amazon.Glacier.Model.ServiceUnavailableException.#ctor(System.String)"> <summary> Constructs a new ServiceUnavailableException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.Glacier.Model.SetVaultNotificationsRequest"> <summary> Container for the parameters to the SetVaultNotifications operation. <para>This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications. </para> <para>To configure vault notifications, send a PUT request to the <c>notification-configuration</c> 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 (InitiateJob). 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 DescribeJob. </li> <li> <b>InventoryRetrievalCompleted</b> This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). 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 DescribeJob. </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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.SetVaultNotifications(Amazon.Glacier.Model.SetVaultNotificationsRequest)"/> </member> <member name="M:Amazon.Glacier.Model.SetVaultNotificationsRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.SetVaultNotificationsRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.SetVaultNotificationsRequest.WithVaultNotificationConfig(Amazon.Glacier.Model.VaultNotificationConfig)"> <summary> Sets the VaultNotificationConfig property </summary> <param name="vaultNotificationConfig">The value to set for the VaultNotificationConfig property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.SetVaultNotificationsRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.SetVaultNotificationsRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.SetVaultNotificationsRequest.VaultNotificationConfig"> <summary> Provides options for specifying notification configuration. </summary> </member> <member name="T:Amazon.Glacier.Model.SetVaultNotificationsResponse"> <summary> Returns information about the SetVaultNotifications response metadata. The SetVaultNotifications operation has a void result type. </summary> </member> <member name="T:Amazon.Glacier.Model.UploadArchiveRequest"> <summary> Container for the parameters to the UploadArchive operation. <para>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 <c>x-amz-archive-id</c> header of the response. </para> <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 InitiateJob. </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 InitiateJob. 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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadArchive(Amazon.Glacier.Model.UploadArchiveRequest)"/> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveRequest.WithArchiveDescription(System.String)"> <summary> Sets the ArchiveDescription property </summary> <param name="archiveDescription">The value to set for the ArchiveDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveRequest.WithChecksum(System.String)"> <summary> Sets the Checksum property </summary> <param name="checksum">The value to set for the Checksum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveRequest.WithBody(System.IO.Stream)"> <summary> Sets the Body property </summary> <param name="body">The value to set for the Body property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveRequest.ArchiveDescription"> <summary> The optional description of the archive you are uploading. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveRequest.Checksum"> <summary> The SHA256 checksum (a linear hash) of the payload. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveRequest.Body"> <summary> The data to upload. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveRequest.StreamTransferProgress"> <summary> Attach a callback that will be called as data is being sent to the AWS Service. </summary> </member> <member name="T:Amazon.Glacier.Model.UploadArchiveResponse"> <summary> Returns information about the UploadArchiveResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveResponse.UploadArchiveResult"> <summary> Gets and sets the UploadArchiveResult property. Contains the Amazon Glacier response to your request. For information about the underlying REST API, go to Upload Archive. For conceptual information, go to Working with Archives in Amazon Glacier. </summary> </member> <member name="T:Amazon.Glacier.Model.UploadArchiveResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> <para>For information about the underlying REST API, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html" >Upload Archive</a> . For conceptual information, go to <a href="http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html" >Working with Archives in Amazon Glacier</a> .</para> </summary> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveResult.WithLocation(System.String)"> <summary> Sets the Location property </summary> <param name="location">The value to set for the Location property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveResult.WithChecksum(System.String)"> <summary> Sets the Checksum property </summary> <param name="checksum">The value to set for the Checksum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadArchiveResult.WithArchiveId(System.String)"> <summary> Sets the ArchiveId property </summary> <param name="archiveId">The value to set for the ArchiveId property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveResult.Location"> <summary> The relative URI path of the newly added archive resource. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveResult.Checksum"> <summary> The checksum of the archive computed by Amazon Glacier. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadArchiveResult.ArchiveId"> <summary> The ID of the archive. This value is also included as part of the location. </summary> </member> <member name="T:Amazon.Glacier.Model.UploadListElement"> <summary> <para>A list of in-progress multipart uploads for a vault.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.UploadListElement.WithMultipartUploadId(System.String)"> <summary> Sets the MultipartUploadId property </summary> <param name="multipartUploadId">The value to set for the MultipartUploadId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadListElement.WithVaultARN(System.String)"> <summary> Sets the VaultARN property </summary> <param name="vaultARN">The value to set for the VaultARN property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadListElement.WithArchiveDescription(System.String)"> <summary> Sets the ArchiveDescription property </summary> <param name="archiveDescription">The value to set for the ArchiveDescription property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadListElement.WithPartSizeInBytes(System.Int64)"> <summary> Sets the PartSizeInBytes property </summary> <param name="partSizeInBytes">The value to set for the PartSizeInBytes property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadListElement.WithCreationDate(System.DateTime)"> <summary> Sets the CreationDate property </summary> <param name="creationDate">The value to set for the CreationDate property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.UploadListElement.MultipartUploadId"> <summary> The ID of a multipart upload. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadListElement.VaultARN"> <summary> The Amazon Resource Name (ARN) of the vault that contains the archive. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadListElement.ArchiveDescription"> <summary> The description of the archive that was specified in the Initiate Multipart Upload request. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadListElement.PartSizeInBytes"> <summary> The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadListElement.CreationDate"> <summary> The UTC time at which the multipart upload was initiated. </summary> </member> <member name="T:Amazon.Glacier.Model.UploadMultipartPartRequest"> <summary> Container for the parameters to the UploadMultipartPart operation. <para>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> <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 InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.</para> <para><b>NOTE:</b> 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> </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> <seealso cref="M:Amazon.Glacier.AmazonGlacier.UploadMultipartPart(Amazon.Glacier.Model.UploadMultipartPartRequest)"/> </member> <member name="M:Amazon.Glacier.Model.UploadMultipartPartRequest.WithAccountId(System.String)"> <summary> Sets the AccountId property </summary> <param name="accountId">The value to set for the AccountId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadMultipartPartRequest.WithVaultName(System.String)"> <summary> Sets the VaultName property </summary> <param name="vaultName">The value to set for the VaultName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadMultipartPartRequest.WithUploadId(System.String)"> <summary> Sets the UploadId property </summary> <param name="uploadId">The value to set for the UploadId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadMultipartPartRequest.WithChecksum(System.String)"> <summary> Sets the Checksum property </summary> <param name="checksum">The value to set for the Checksum property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadMultipartPartRequest.WithRange(System.String)"> <summary> Sets the Range property </summary> <param name="range">The value to set for the Range property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.UploadMultipartPartRequest.WithBody(System.IO.Stream)"> <summary> Sets the Body property </summary> <param name="body">The value to set for the Body property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartRequest.AccountId"> <summary> The <c>AccountId</c> is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartRequest.VaultName"> <summary> The name of the vault. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartRequest.UploadId"> <summary> The upload ID of the multipart upload. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartRequest.Checksum"> <summary> The SHA256 tree hash of the data being uploaded. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartRequest.Range"> <summary> Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartRequest.Body"> <summary> The data to upload. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartRequest.StreamTransferProgress"> <summary> Attach a callback that will be called as data is being sent to the AWS Service. </summary> </member> <member name="T:Amazon.Glacier.Model.UploadMultipartPartResponse"> <summary> Returns information about the UploadMultipartPartResult response and response metadata. </summary> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartResponse.UploadMultipartPartResult"> <summary> Gets and sets the UploadMultipartPartResult property. Contains the Amazon Glacier response to your request. </summary> </member> <member name="T:Amazon.Glacier.Model.UploadMultipartPartResult"> <summary> <para>Contains the Amazon Glacier response to your request.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.UploadMultipartPartResult.WithChecksum(System.String)"> <summary> Sets the Checksum property </summary> <param name="checksum">The value to set for the Checksum property </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.UploadMultipartPartResult.Checksum"> <summary> The SHA256 tree hash that Amazon Glacier computed for the uploaded part. </summary> </member> <member name="T:Amazon.Glacier.Model.VaultNotificationConfig"> <summary> <para>Represents a vault's notification configuration.</para> </summary> </member> <member name="M:Amazon.Glacier.Model.VaultNotificationConfig.WithSNSTopic(System.String)"> <summary> Sets the SNSTopic property </summary> <param name="sNSTopic">The value to set for the SNSTopic property </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.VaultNotificationConfig.WithEvents(System.String[])"> <summary> Adds elements to the Events collection </summary> <param name="events">The values to add to the Events collection </param> <returns>this instance</returns> </member> <member name="M:Amazon.Glacier.Model.VaultNotificationConfig.WithEvents(System.Collections.Generic.IEnumerable{System.String})"> <summary> Adds elements to the Events collection </summary> <param name="events">The values to add to the Events collection </param> <returns>this instance</returns> </member> <member name="P:Amazon.Glacier.Model.VaultNotificationConfig.SNSTopic"> <summary> The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.Glacier.Model.VaultNotificationConfig.Events"> <summary> A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic. </summary> </member> <member name="T:Amazon.Glacier.Transfer.CommonOptions"> <summary> Common options used for requests to Amazon Glacier. </summary> </member> <member name="P:Amazon.Glacier.Transfer.CommonOptions.AccountId"> <summary> The ID for the account which owns the Glacier vault. </summary> </member> <member name="T:Amazon.Glacier.Transfer.DownloadOptions"> <summary> Common options used for download methods. </summary> </member> <member name="P:Amazon.Glacier.Transfer.DownloadOptions.PollingInterval"> <summary> The polling interval in minutes for reading messages from the SQS queue. </summary> </member> <member name="P:Amazon.Glacier.Transfer.DownloadOptions.StreamTransferProgress"> <summary> The delegate callback to track the progress of the download. </summary> </member> <member name="P:Amazon.Glacier.Transfer.InitiateArchiveRetrievalOptions.SNSTopic"> <summary> The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist. </summary> </member> <member name="M:Amazon.Glacier.Transfer.Internal.DownloadFileCommand.readNextMessage"> <summary> Poll messages from the queue. Given the download process takes many hours there is extra long retry logic. </summary> <returns>The next message in the queue;</returns> </member> <member name="M:Amazon.Glacier.Transfer.Internal.DownloadFileCommand.getJobIdFromMessage(Amazon.SQS.Model.Message)"> <summary> Parse the sqs message to make sure it contains the right job id and that the job was successful </summary> <param name="message"></param> </member> <member name="M:Amazon.Glacier.Transfer.Internal.MultipartUploadCommand.CalculatePartSize(System.Int64)"> <summary> Calculates the part size to use when uploading an archive of the specified size using Glacier's multipart upload APIs. Because of the tree hashing algorithm, part sizes must be aligned on 2^n MB boundaries (ex: 1MB, 2MB, 4MB, 8MB, etc). All parts must be the same size, except for the last part. </summary> <param name="fileSize">The size of the file being uploaded.</param> <returns>The part size to use in the multipart upload.</returns> </member> <member name="T:Amazon.Glacier.Transfer.UploadOptions"> <summary> Options that can be specified for upload methods. </summary> </member> <member name="P:Amazon.Glacier.Transfer.UploadOptions.StreamTransferProgress"> <summary> The delegate callback for tracking the progress of the upload. </summary> </member> <member name="T:Amazon.Glacier.Transfer.UploadResult"> <summary> A type that represents the result of a single file upload. </summary> </member> <member name="M:Amazon.Glacier.Transfer.UploadResult.#ctor(System.String,System.String)"> <summary> Constructs a new UploadResult object with the specified archive ID. </summary> <param name="archiveId">The ID of the uploaded archive.</param> <param name="checkSum">The check sum computed for the file uploaded.</param> </member> <member name="P:Amazon.Glacier.Transfer.UploadResult.ArchiveId"> <summary> Returns the ID of the uploaded archive. </summary> </member> <member name="T:Amazon.Glacier.TreeHashGenerator"> <summary> This class computes the tree hash that is set on the CheckSum property on UploadArchiveRequest, UploadMultipartPartRequest and CompleteMultipartUploadRequest. </summary> </member> <member name="M:Amazon.Glacier.TreeHashGenerator.CalculateTreeHash(System.IO.Stream)"> <summary> This method computes the tree hash used by glacier. It reads the whole stream and then resets the position of the stream back to the beginning. </summary> <param name="stream">The stream to read and compute the tree hash for.</param> <returns>The tree hash that can be used to set the the Checksum property.</returns> </member> <member name="M:Amazon.Glacier.TreeHashGenerator.CalculateTreeHash(System.Collections.Generic.IEnumerable{System.String})"> <summary> This method computes the final tree hash used on the CompleteMultipartUploadRequest from the tree hashes of the individual part uploaded. </summary> <param name="partsTreeHash">The list of tree hashes for the individual parts.</param> <returns>The tree hash that can be used to set the the Checksum property.</returns> </member> <member name="T:Amazon.IdentityManagement.AmazonIdentityManagementService"> <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 the IAM API. For general information about IAM, see <a href="http://aws.amazon.com/iam/" target="_blank">AWS Identity and Access Management (IAM)</a>. For the user guide for IAM, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/" target="_blank">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> Using the IAM Query API, you make direct calls to the IAM web service. 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>Recording API requests</b> </para> <para> IAM 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 IAM, 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/whatisawscloudtrail.html">AWS CloudTrail User Guide</a>. </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" target="_blank">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" target="_blank">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/STS/latest/UsingSTS/" target="_blank">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" target="_blank">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.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginAddRoleToInstanceProfile(Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddRoleToInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the AddRoleToInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddRoleToInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndAddRoleToInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddRoleToInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddRoleToInstanceProfile.</param> <returns>Returns a AddRoleToInstanceProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginAddUserToGroup(Amazon.IdentityManagement.Model.AddUserToGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddUserToGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the AddUserToGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddUserToGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndAddUserToGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddUserToGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddUserToGroup.</param> <returns>Returns a AddUserToGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ChangePassword(Amazon.IdentityManagement.Model.ChangePasswordRequest)"> <summary> Changes the password of the IAM user calling <code>ChangePassword</code>. The root account password is not affected by this action. For information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html" target="_blank">Managing Passwords</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginChangePassword(Amazon.IdentityManagement.Model.ChangePasswordRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ChangePassword operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ChangePassword operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndChangePassword operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndChangePassword(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ChangePassword operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginChangePassword.</param> <returns>Returns a ChangePasswordResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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 API 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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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 API 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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateAccessKey(Amazon.IdentityManagement.Model.CreateAccessKeyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateAccessKey operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAccessKey operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateAccessKey(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAccessKey.</param> <returns>Returns a CreateAccessKeyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.CreateAccountAlias(Amazon.IdentityManagement.Model.CreateAccountAliasRequest)"> <summary> This action 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" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateAccountAlias(Amazon.IdentityManagement.Model.CreateAccountAliasRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateAccountAlias operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAccountAlias operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateAccountAlias(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAccountAlias.</param> <returns>Returns a CreateAccountAliasResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateGroup(Amazon.IdentityManagement.Model.CreateGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateGroup.</param> <returns>Returns a CreateGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateInstanceProfile(Amazon.IdentityManagement.Model.CreateInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInstanceProfile.</param> <returns>Returns a CreateInstanceProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Managing Passwords</a> in <i>Using IAM</i>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateLoginProfile(Amazon.IdentityManagement.Model.CreateLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoginProfile.</param> <returns>Returns a CreateLoginProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. <para> The example policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </para> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateRole(Amazon.IdentityManagement.Model.CreateRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRole.</param> <returns>Returns a CreateRoleResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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/STS/latest/UsingSTS/STSMgmtConsole-SAML.html">Giving Console Access Using SAML</a> and <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html">Creating Temporary Security Credentials for SAML Federation</a> in the <i>Using Temporary Credentials</i> guide. </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"> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateSAMLProvider(Amazon.IdentityManagement.Model.CreateSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSAMLProvider.</param> <returns>Returns a CreateSAMLProviderResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateUser(Amazon.IdentityManagement.Model.CreateUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateUser.</param> <returns>Returns a CreateUserResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.CreateVirtualMFADevice(Amazon.IdentityManagement.Model.CreateVirtualMFADeviceRequest)"> <summary> Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_EnableMFADevice.html" target="_blank">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" target="_blank">Using a Virtual MFA Device</a> in <i>Using AWS Identity and Access Management</i>. <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" target="_blank">Limitations on Entities</a> in <i>Using AWS Identity and Access Management</i>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginCreateVirtualMFADevice(Amazon.IdentityManagement.Model.CreateVirtualMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateVirtualMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVirtualMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndCreateVirtualMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVirtualMFADevice.</param> <returns>Returns a CreateVirtualMFADeviceResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeactivateMFADevice(Amazon.IdentityManagement.Model.DeactivateMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeactivateMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeactivateMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeactivateMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeactivateMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeactivateMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeactivateMFADevice.</param> <returns>Returns a DeactivateMFADeviceResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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 API 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteAccessKey(Amazon.IdentityManagement.Model.DeleteAccessKeyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccessKey operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAccessKey operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteAccessKey(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAccessKey.</param> <returns>Returns a DeleteAccessKeyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteAccountAlias(Amazon.IdentityManagement.Model.DeleteAccountAliasRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountAlias operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAccountAlias operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteAccountAlias(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAccountAlias.</param> <returns>Returns a DeleteAccountAliasResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteAccountPasswordPolicy(Amazon.IdentityManagement.Model.DeleteAccountPasswordPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountPasswordPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAccountPasswordPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteAccountPasswordPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAccountPasswordPolicy.</param> <returns>Returns a DeleteAccountPasswordPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteGroup(Amazon.IdentityManagement.Model.DeleteGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteGroup.</param> <returns>Returns a DeleteGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.DeleteGroupPolicy(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest)"> <summary> Deletes the specified policy that is associated with the specified group. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteGroupPolicy(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroupPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteGroupPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteGroupPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteGroupPolicy.</param> <returns>Returns a DeleteGroupPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteInstanceProfile(Amazon.IdentityManagement.Model.DeleteInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInstanceProfile.</param> <returns>Returns a DeleteInstanceProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteLoginProfile(Amazon.IdentityManagement.Model.DeleteLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoginProfile.</param> <returns>Returns a DeleteLoginProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteRole(Amazon.IdentityManagement.Model.DeleteRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRole.</param> <returns>Returns a DeleteRoleResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.DeleteRolePolicy(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest)"> <summary> Deletes the specified policy associated with the specified role. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteRolePolicy(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRolePolicy.</param> <returns>Returns a DeleteRolePolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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"> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteSAMLProvider(Amazon.IdentityManagement.Model.DeleteSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSAMLProvider.</param> <returns>Returns a DeleteSAMLProviderResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.DeleteServerCertificate(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest)"> <summary> Deletes the specified server certificate. <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" target="blank">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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteServerCertificate(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteServerCertificate.</param> <returns>Returns a DeleteServerCertificateResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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 API 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteSigningCertificate(Amazon.IdentityManagement.Model.DeleteSigningCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSigningCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSigningCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteSigningCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSigningCertificate.</param> <returns>Returns a DeleteSigningCertificateResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteUser(Amazon.IdentityManagement.Model.DeleteUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteUser.</param> <returns>Returns a DeleteUserResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.DeleteUserPolicy(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest)"> <summary> Deletes the specified policy associated with the specified user. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteUserPolicy(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteUserPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteUserPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteUserPolicy.</param> <returns>Returns a DeleteUserPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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 href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_DeactivateMFADevice.html">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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginDeleteVirtualMFADevice(Amazon.IdentityManagement.Model.DeleteVirtualMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVirtualMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndDeleteVirtualMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVirtualMFADevice.</param> <returns>Returns a DeleteVirtualMFADeviceResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginEnableMFADevice(Amazon.IdentityManagement.Model.EnableMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the EnableMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndEnableMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableMFADevice.</param> <returns>Returns a EnableMFADeviceResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetAccountPasswordPolicy(Amazon.IdentityManagement.Model.GetAccountPasswordPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountPasswordPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetAccountPasswordPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetAccountPasswordPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetAccountPasswordPolicy.</param> <returns>Returns a GetAccountPasswordPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetAccountSummary"> <summary> Retrieves account level information about account entity usage and IAM quotas. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> </summary> <returns>The response from the GetAccountSummary service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetAccountSummary(Amazon.IdentityManagement.Model.GetAccountSummaryRequest)"> <summary> Retrieves account level information about account entity usage and IAM quotas. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetAccountSummary(Amazon.IdentityManagement.Model.GetAccountSummaryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetAccountSummary operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSummary operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetAccountSummary operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetAccountSummary(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetAccountSummary operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetAccountSummary.</param> <returns>Returns a GetAccountSummaryResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetGroup(Amazon.IdentityManagement.Model.GetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetGroup.</param> <returns>Returns a GetGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetGroupPolicy(Amazon.IdentityManagement.Model.GetGroupPolicyRequest)"> <summary> Retrieves the specified policy document for the specified group. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetGroupPolicy(Amazon.IdentityManagement.Model.GetGroupPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetGroupPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetGroupPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetGroupPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetGroupPolicy.</param> <returns>Returns a GetGroupPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetInstanceProfile(Amazon.IdentityManagement.Model.GetInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetInstanceProfile.</param> <returns>Returns a GetInstanceProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetLoginProfile(Amazon.IdentityManagement.Model.GetLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetLoginProfile.</param> <returns>Returns a GetLoginProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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>. <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </para> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetRole(Amazon.IdentityManagement.Model.GetRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRole.</param> <returns>Returns a GetRoleResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetRolePolicy(Amazon.IdentityManagement.Model.GetRolePolicyRequest)"> <summary> Retrieves the specified policy document for the specified role. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetRolePolicy(Amazon.IdentityManagement.Model.GetRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRolePolicy.</param> <returns>Returns a GetRolePolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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"> </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.AmazonIdentityManagementService.BeginGetSAMLProvider(Amazon.IdentityManagement.Model.GetSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetSAMLProvider.</param> <returns>Returns a GetSAMLProviderResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetServerCertificate(Amazon.IdentityManagement.Model.GetServerCertificateRequest)"> <summary> Retrieves information about the specified server certificate. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetServerCertificate(Amazon.IdentityManagement.Model.GetServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetServerCertificate.</param> <returns>Returns a GetServerCertificateResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetUser"> <summary> Retrieves information about the specified user, including the user's 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 signing 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetUser(Amazon.IdentityManagement.Model.GetUserRequest)"> <summary> Retrieves information about the specified user, including the user's 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 signing 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetUser(Amazon.IdentityManagement.Model.GetUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetUser.</param> <returns>Returns a GetUserResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.GetUserPolicy(Amazon.IdentityManagement.Model.GetUserPolicyRequest)"> <summary> Retrieves the specified policy document for the specified user. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginGetUserPolicy(Amazon.IdentityManagement.Model.GetUserPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetUserPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetUserPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndGetUserPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetUserPolicy.</param> <returns>Returns a GetUserPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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, this API can be used 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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, this API can be used 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListAccessKeys(Amazon.IdentityManagement.Model.ListAccessKeysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAccessKeys operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListAccessKeys operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAccessKeys operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListAccessKeys(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAccessKeys operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAccessKeys.</param> <returns>Returns a ListAccessKeysResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ListAccountAliases"> <summary> Lists the account aliases associated with the account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</i>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ListAccountAliases(Amazon.IdentityManagement.Model.ListAccountAliasesRequest)"> <summary> Lists the account aliases associated with the account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</i>. <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 ListAccountAliases service method.</param> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListAccountAliases(Amazon.IdentityManagement.Model.ListAccountAliasesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAccountAliases operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListAccountAliases operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAccountAliases operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListAccountAliases(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAccountAliases operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAccountAliases.</param> <returns>Returns a ListAccountAliasesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ListGroupPolicies(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest)"> <summary> Lists the names of the policies associated with the specified group. 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListGroupPolicies(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListGroupPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupPolicies operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroupPolicies operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListGroupPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListGroupPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListGroupPolicies.</param> <returns>Returns a ListGroupPoliciesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListGroups(Amazon.IdentityManagement.Model.ListGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListGroups operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListGroups operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroups operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListGroups operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListGroups.</param> <returns>Returns a ListGroupsResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListGroupsForUser(Amazon.IdentityManagement.Model.ListGroupsForUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListGroupsForUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupsForUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroupsForUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListGroupsForUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListGroupsForUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListGroupsForUser.</param> <returns>Returns a ListGroupsForUserResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListInstanceProfiles(Amazon.IdentityManagement.Model.ListInstanceProfilesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstanceProfiles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfiles operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstanceProfiles operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListInstanceProfiles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstanceProfiles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstanceProfiles.</param> <returns>Returns a ListInstanceProfilesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListInstanceProfilesForRole(Amazon.IdentityManagement.Model.ListInstanceProfilesForRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstanceProfilesForRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfilesForRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstanceProfilesForRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListInstanceProfilesForRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstanceProfilesForRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstanceProfilesForRole.</param> <returns>Returns a ListInstanceProfilesForRoleResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListMFADevices(Amazon.IdentityManagement.Model.ListMFADevicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListMFADevices operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMFADevices operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListMFADevices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMFADevices.</param> <returns>Returns a ListMFADevicesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ListRolePolicies(Amazon.IdentityManagement.Model.ListRolePoliciesRequest)"> <summary> Lists the names of the policies associated with the specified role. 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListRolePolicies(Amazon.IdentityManagement.Model.ListRolePoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRolePolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListRolePolicies operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRolePolicies operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListRolePolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRolePolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRolePolicies.</param> <returns>Returns a ListRolePoliciesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </para> </summary> <returns>The response from the ListRoles service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListRoles(Amazon.IdentityManagement.Model.ListRolesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRoles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListRoles operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRoles operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListRoles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRoles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRoles.</param> <returns>Returns a ListRolesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListSAMLProviders(Amazon.IdentityManagement.Model.ListSAMLProvidersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSAMLProviders operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListSAMLProviders operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSAMLProviders operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListSAMLProviders(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSAMLProviders operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSAMLProviders.</param> <returns>Returns a ListSAMLProvidersResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </summary> <returns>The response from the ListServerCertificates service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListServerCertificates(Amazon.IdentityManagement.Model.ListServerCertificatesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListServerCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListServerCertificates operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListServerCertificates operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListServerCertificates(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListServerCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListServerCertificates.</param> <returns>Returns a ListServerCertificatesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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, this API can be used 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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, this API can be used 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListSigningCertificates(Amazon.IdentityManagement.Model.ListSigningCertificatesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSigningCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListSigningCertificates operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSigningCertificates operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListSigningCertificates(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSigningCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSigningCertificates.</param> <returns>Returns a ListSigningCertificatesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ListUserPolicies(Amazon.IdentityManagement.Model.ListUserPoliciesRequest)"> <summary> Lists the names of the policies associated with the specified user. 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListUserPolicies(Amazon.IdentityManagement.Model.ListUserPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUserPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListUserPolicies operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUserPolicies operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListUserPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUserPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUserPolicies.</param> <returns>Returns a ListUserPoliciesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ListUsers"> <summary> Lists the users that have the specified path prefix. 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ListUsers(Amazon.IdentityManagement.Model.ListUsersRequest)"> <summary> Lists the users that have the specified path prefix. 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginListUsers(Amazon.IdentityManagement.Model.ListUsersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUsers operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListUsers operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUsers operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListUsers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUsers operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUsers.</param> <returns>Returns a ListUsersResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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.AmazonIdentityManagementService.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.AmazonIdentityManagementService.BeginListVirtualMFADevices(Amazon.IdentityManagement.Model.ListVirtualMFADevicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListVirtualMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListVirtualMFADevices operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVirtualMFADevices operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndListVirtualMFADevices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListVirtualMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListVirtualMFADevices.</param> <returns>Returns a ListVirtualMFADevicesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.PutGroupPolicy(Amazon.IdentityManagement.Model.PutGroupPolicyRequest)"> <summary> Adds (or updates) a policy document associated with the specified group. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html" target="_blank">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>. <para> For information about limits on the number of policies you can associate with a group, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginPutGroupPolicy(Amazon.IdentityManagement.Model.PutGroupPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the PutGroupPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutGroupPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndPutGroupPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutGroupPolicy.</param> <returns>Returns a PutGroupPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.PutRolePolicy(Amazon.IdentityManagement.Model.PutRolePolicyRequest)"> <summary> Adds (or updates) a policy document associated with the specified role. For information about policies, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html" target="_blank">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>. <para> For information about limits on the policies you can associate with a role, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginPutRolePolicy(Amazon.IdentityManagement.Model.PutRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the PutRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndPutRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutRolePolicy.</param> <returns>Returns a PutRolePolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.PutUserPolicy(Amazon.IdentityManagement.Model.PutUserPolicyRequest)"> <summary> Adds (or updates) a policy document associated with the specified user. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html" target="_blank">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>. <para> For information about limits on the number of policies you can associate with a user, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginPutUserPolicy(Amazon.IdentityManagement.Model.PutUserPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the PutUserPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutUserPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndPutUserPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutUserPolicy.</param> <returns>Returns a PutUserPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginRemoveRoleFromInstanceProfile(Amazon.IdentityManagement.Model.RemoveRoleFromInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveRoleFromInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the RemoveRoleFromInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveRoleFromInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndRemoveRoleFromInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveRoleFromInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveRoleFromInstanceProfile.</param> <returns>Returns a RemoveRoleFromInstanceProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginRemoveUserFromGroup(Amazon.IdentityManagement.Model.RemoveUserFromGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveUserFromGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the RemoveUserFromGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveUserFromGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndRemoveUserFromGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveUserFromGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveUserFromGroup.</param> <returns>Returns a RemoveUserFromGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.ResyncMFADevice(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest)"> <summary> Synchronizes the specified MFA device with AWS servers. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginResyncMFADevice(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResyncMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ResyncMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResyncMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndResyncMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResyncMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResyncMFADevice.</param> <returns>Returns a ResyncMFADeviceResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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, this API can be used 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" target="_blank">Managing Keys and Certificates</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateAccessKey(Amazon.IdentityManagement.Model.UpdateAccessKeyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccessKey operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAccessKey operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateAccessKey(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAccessKey.</param> <returns>Returns a UpdateAccessKeyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.UpdateAccountPasswordPolicy"> <summary> Updates the password policy settings for the 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.UpdateAccountPasswordPolicy(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest)"> <summary> Updates the password policy settings for the 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateAccountPasswordPolicy(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccountPasswordPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAccountPasswordPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateAccountPasswordPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAccountPasswordPolicy.</param> <returns>Returns a UpdateAccountPasswordPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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/WorkingWithRoles.html">Working with Roles</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateAssumeRolePolicy(Amazon.IdentityManagement.Model.UpdateAssumeRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAssumeRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssumeRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAssumeRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateAssumeRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAssumeRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAssumeRolePolicy.</param> <returns>Returns a UpdateAssumeRolePolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Renaming Users and Groups</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateGroup(Amazon.IdentityManagement.Model.UpdateGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateGroup.</param> <returns>Returns a UpdateGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.UpdateLoginProfile(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest)"> <summary> Changes the password for the specified user. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateLoginProfile(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateLoginProfile.</param> <returns>Returns a UpdateLoginProfileResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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"> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateSAMLProvider(Amazon.IdentityManagement.Model.UpdateSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSAMLProvider.</param> <returns>Returns a UpdateSAMLProviderResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.UpdateServerCertificate(Amazon.IdentityManagement.Model.UpdateServerCertificateRequest)"> <summary> Updates the name and/or the path of the specified server certificate. <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/ManagingServerCerts.html" target="_blank">Managing Server Certificates</a> in <i>Using AWS Identity and Access Management</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/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateServerCertificate(Amazon.IdentityManagement.Model.UpdateServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServerCertificate.</param> <returns>Returns a UpdateServerCertificateResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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, this API can be used to manage root credentials even if the AWS account has no associated users. </para> <para> For information about rotating certificates, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html" target="_blank">Managing Keys and Certificates</a> in <i>Using AWS Identity and Access Management</i>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateSigningCertificate(Amazon.IdentityManagement.Model.UpdateSigningCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSigningCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSigningCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateSigningCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSigningCertificate.</param> <returns>Returns a UpdateSigningCertificateResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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" target="_blank">Renaming Users and Groups</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUpdateUser(Amazon.IdentityManagement.Model.UpdateUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUpdateUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateUser.</param> <returns>Returns a UpdateUserResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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 information about the number of server certificates you can upload, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUploadServerCertificate(Amazon.IdentityManagement.Model.UploadServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UploadServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUploadServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadServerCertificate.</param> <returns>Returns a UploadServerCertificateResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.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, this API can be used 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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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 to another user under 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.BeginUploadSigningCertificate(Amazon.IdentityManagement.Model.UploadSigningCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UploadSigningCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadSigningCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementService.EndUploadSigningCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadSigningCertificate.</param> <returns>Returns a UploadSigningCertificateResult from IdentityManagementService.</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 the IAM API. For general information about IAM, see <a href="http://aws.amazon.com/iam/" target="_blank">AWS Identity and Access Management (IAM)</a>. For the user guide for IAM, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/" target="_blank">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> Using the IAM Query API, you make direct calls to the IAM web service. 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>Recording API requests</b> </para> <para> IAM 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 IAM, 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/whatisawscloudtrail.html">AWS CloudTrail User Guide</a>. </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" target="_blank">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" target="_blank">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/STS/latest/UsingSTS/" target="_blank">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" target="_blank">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.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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </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.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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginAddRoleToInstanceProfile(Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddRoleToInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the AddRoleToInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddRoleToInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndAddRoleToInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddRoleToInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddRoleToInstanceProfile.</param> <returns>Returns a AddRoleToInstanceProfileResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginAddUserToGroup(Amazon.IdentityManagement.Model.AddUserToGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddUserToGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the AddUserToGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddUserToGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndAddUserToGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddUserToGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddUserToGroup.</param> <returns>Returns a AddUserToGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ChangePassword(Amazon.IdentityManagement.Model.ChangePasswordRequest)"> <summary> Changes the password of the IAM user calling <code>ChangePassword</code>. The root account password is not affected by this action. For information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html" target="_blank">Managing Passwords</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginChangePassword(Amazon.IdentityManagement.Model.ChangePasswordRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ChangePassword operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ChangePassword operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndChangePassword operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndChangePassword(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ChangePassword operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginChangePassword.</param> <returns>Returns a ChangePasswordResult from IdentityManagementService.</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 API 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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </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 API 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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateAccessKey(Amazon.IdentityManagement.Model.CreateAccessKeyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateAccessKey operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAccessKey operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateAccessKey(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAccessKey.</param> <returns>Returns a CreateAccessKeyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.CreateAccountAlias(Amazon.IdentityManagement.Model.CreateAccountAliasRequest)"> <summary> This action 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" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateAccountAlias(Amazon.IdentityManagement.Model.CreateAccountAliasRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateAccountAlias operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAccountAlias operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateAccountAlias(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAccountAlias.</param> <returns>Returns a CreateAccountAliasResult from IdentityManagementService.</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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateGroup(Amazon.IdentityManagement.Model.CreateGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateGroup.</param> <returns>Returns a CreateGroupResult from IdentityManagementService.</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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateInstanceProfile(Amazon.IdentityManagement.Model.CreateInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInstanceProfile.</param> <returns>Returns a CreateInstanceProfileResult from IdentityManagementService.</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" target="_blank">Managing Passwords</a> in <i>Using IAM</i>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateLoginProfile(Amazon.IdentityManagement.Model.CreateLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLoginProfile.</param> <returns>Returns a CreateLoginProfileResult from IdentityManagementService.</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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. <para> The example policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </para> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateRole(Amazon.IdentityManagement.Model.CreateRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRole.</param> <returns>Returns a CreateRoleResult from IdentityManagementService.</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/STS/latest/UsingSTS/STSMgmtConsole-SAML.html">Giving Console Access Using SAML</a> and <a href="http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html">Creating Temporary Security Credentials for SAML Federation</a> in the <i>Using Temporary Credentials</i> guide. </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"> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateSAMLProvider(Amazon.IdentityManagement.Model.CreateSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSAMLProvider.</param> <returns>Returns a CreateSAMLProviderResult from IdentityManagementService.</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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateUser(Amazon.IdentityManagement.Model.CreateUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateUser.</param> <returns>Returns a CreateUserResult from IdentityManagementService.</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 href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_EnableMFADevice.html" target="_blank">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" target="_blank">Using a Virtual MFA Device</a> in <i>Using AWS Identity and Access Management</i>. <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" target="_blank">Limitations on Entities</a> in <i>Using AWS Identity and Access Management</i>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginCreateVirtualMFADevice(Amazon.IdentityManagement.Model.CreateVirtualMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the CreateVirtualMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVirtualMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndCreateVirtualMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVirtualMFADevice.</param> <returns>Returns a CreateVirtualMFADeviceResult from IdentityManagementService.</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. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeactivateMFADevice(Amazon.IdentityManagement.Model.DeactivateMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeactivateMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeactivateMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeactivateMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeactivateMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeactivateMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeactivateMFADevice.</param> <returns>Returns a DeactivateMFADeviceResult from IdentityManagementService.</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 API 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteAccessKey(Amazon.IdentityManagement.Model.DeleteAccessKeyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccessKey operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAccessKey operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteAccessKey(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAccessKey.</param> <returns>Returns a DeleteAccessKeyResult from IdentityManagementService.</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" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteAccountAlias(Amazon.IdentityManagement.Model.DeleteAccountAliasRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountAlias operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAccountAlias operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteAccountAlias(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAccountAlias operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAccountAlias.</param> <returns>Returns a DeleteAccountAliasResult from IdentityManagementService.</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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteAccountPasswordPolicy(Amazon.IdentityManagement.Model.DeleteAccountPasswordPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAccountPasswordPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAccountPasswordPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteAccountPasswordPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAccountPasswordPolicy.</param> <returns>Returns a DeleteAccountPasswordPolicyResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteGroup(Amazon.IdentityManagement.Model.DeleteGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteGroup.</param> <returns>Returns a DeleteGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteGroupPolicy(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest)"> <summary> Deletes the specified policy that is associated with the specified group. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteGroupPolicy(Amazon.IdentityManagement.Model.DeleteGroupPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteGroupPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteGroupPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteGroupPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteGroupPolicy.</param> <returns>Returns a DeleteGroupPolicyResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteInstanceProfile(Amazon.IdentityManagement.Model.DeleteInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInstanceProfile.</param> <returns>Returns a DeleteInstanceProfileResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteLoginProfile(Amazon.IdentityManagement.Model.DeleteLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLoginProfile.</param> <returns>Returns a DeleteLoginProfileResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteRole(Amazon.IdentityManagement.Model.DeleteRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRole.</param> <returns>Returns a DeleteRoleResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteRolePolicy(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest)"> <summary> Deletes the specified policy associated with the specified role. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteRolePolicy(Amazon.IdentityManagement.Model.DeleteRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRolePolicy.</param> <returns>Returns a DeleteRolePolicyResult from IdentityManagementService.</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"> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteSAMLProvider(Amazon.IdentityManagement.Model.DeleteSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSAMLProvider.</param> <returns>Returns a DeleteSAMLProviderResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteServerCertificate(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest)"> <summary> Deletes the specified server certificate. <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" target="blank">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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteServerCertificate(Amazon.IdentityManagement.Model.DeleteServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteServerCertificate.</param> <returns>Returns a DeleteServerCertificateResult from IdentityManagementService.</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 API 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteSigningCertificate(Amazon.IdentityManagement.Model.DeleteSigningCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSigningCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSigningCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteSigningCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSigningCertificate.</param> <returns>Returns a DeleteSigningCertificateResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteUser(Amazon.IdentityManagement.Model.DeleteUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteUser.</param> <returns>Returns a DeleteUserResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.DeleteUserPolicy(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest)"> <summary> Deletes the specified policy associated with the specified user. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteUserPolicy(Amazon.IdentityManagement.Model.DeleteUserPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteUserPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteUserPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteUserPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteUserPolicy.</param> <returns>Returns a DeleteUserPolicyResult from IdentityManagementService.</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 href="http://docs.aws.amazon.com/IAM/latest/APIReference/API_DeactivateMFADevice.html">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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginDeleteVirtualMFADevice(Amazon.IdentityManagement.Model.DeleteVirtualMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVirtualMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndDeleteVirtualMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVirtualMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVirtualMFADevice.</param> <returns>Returns a DeleteVirtualMFADeviceResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginEnableMFADevice(Amazon.IdentityManagement.Model.EnableMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the EnableMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndEnableMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableMFADevice.</param> <returns>Returns a EnableMFADeviceResult from IdentityManagementService.</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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetAccountPasswordPolicy(Amazon.IdentityManagement.Model.GetAccountPasswordPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountPasswordPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetAccountPasswordPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetAccountPasswordPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetAccountPasswordPolicy.</param> <returns>Returns a GetAccountPasswordPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountSummary"> <summary> Retrieves account level information about account entity usage and IAM quotas. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> </summary> <returns>The response from the GetAccountSummary service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetAccountSummary(Amazon.IdentityManagement.Model.GetAccountSummaryRequest)"> <summary> Retrieves account level information about account entity usage and IAM quotas. <para> For information about limitations on IAM entities, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetAccountSummary(Amazon.IdentityManagement.Model.GetAccountSummaryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetAccountSummary operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSummary operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetAccountSummary operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetAccountSummary(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetAccountSummary operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetAccountSummary.</param> <returns>Returns a GetAccountSummaryResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetGroup(Amazon.IdentityManagement.Model.GetGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetGroup.</param> <returns>Returns a GetGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetGroupPolicy(Amazon.IdentityManagement.Model.GetGroupPolicyRequest)"> <summary> Retrieves the specified policy document for the specified group. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetGroupPolicy(Amazon.IdentityManagement.Model.GetGroupPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetGroupPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetGroupPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetGroupPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetGroupPolicy.</param> <returns>Returns a GetGroupPolicyResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetInstanceProfile(Amazon.IdentityManagement.Model.GetInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetInstanceProfile.</param> <returns>Returns a GetInstanceProfileResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetLoginProfile(Amazon.IdentityManagement.Model.GetLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetLoginProfile.</param> <returns>Returns a GetLoginProfileResult from IdentityManagementService.</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>. <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </para> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetRole(Amazon.IdentityManagement.Model.GetRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRole.</param> <returns>Returns a GetRoleResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetRolePolicy(Amazon.IdentityManagement.Model.GetRolePolicyRequest)"> <summary> Retrieves the specified policy document for the specified role. For more information about roles, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html">Working with Roles</a>. <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetRolePolicy(Amazon.IdentityManagement.Model.GetRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRolePolicy.</param> <returns>Returns a GetRolePolicyResult from IdentityManagementService.</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"> </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.BeginGetSAMLProvider(Amazon.IdentityManagement.Model.GetSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetSAMLProvider.</param> <returns>Returns a GetSAMLProviderResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetServerCertificate(Amazon.IdentityManagement.Model.GetServerCertificateRequest)"> <summary> Retrieves information about the specified server certificate. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetServerCertificate(Amazon.IdentityManagement.Model.GetServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetServerCertificate.</param> <returns>Returns a GetServerCertificateResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUser"> <summary> Retrieves information about the specified user, including the user's 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 signing 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUser(Amazon.IdentityManagement.Model.GetUserRequest)"> <summary> Retrieves information about the specified user, including the user's 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 signing 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetUser(Amazon.IdentityManagement.Model.GetUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetUser.</param> <returns>Returns a GetUserResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.GetUserPolicy(Amazon.IdentityManagement.Model.GetUserPolicyRequest)"> <summary> Retrieves the specified policy document for the specified user. The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginGetUserPolicy(Amazon.IdentityManagement.Model.GetUserPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the GetUserPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetUserPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndGetUserPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetUserPolicy.</param> <returns>Returns a GetUserPolicyResult from IdentityManagementService.</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, this API can be used 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> </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, this API can be used 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListAccessKeys(Amazon.IdentityManagement.Model.ListAccessKeysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAccessKeys operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListAccessKeys operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAccessKeys operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListAccessKeys(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAccessKeys operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAccessKeys.</param> <returns>Returns a ListAccessKeysResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccountAliases"> <summary> Lists the account aliases associated with the account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</i>. <para> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </para> </summary> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListAccountAliases(Amazon.IdentityManagement.Model.ListAccountAliasesRequest)"> <summary> Lists the account aliases associated with the account. For information about using an AWS account alias, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</i>. <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 ListAccountAliases service method.</param> <returns>The response from the ListAccountAliases service method, as returned by IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListAccountAliases(Amazon.IdentityManagement.Model.ListAccountAliasesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAccountAliases operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListAccountAliases operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAccountAliases operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListAccountAliases(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAccountAliases operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAccountAliases.</param> <returns>Returns a ListAccountAliasesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListGroupPolicies(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest)"> <summary> Lists the names of the policies associated with the specified group. 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListGroupPolicies(Amazon.IdentityManagement.Model.ListGroupPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListGroupPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupPolicies operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroupPolicies operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListGroupPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListGroupPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListGroupPolicies.</param> <returns>Returns a ListGroupPoliciesResult from IdentityManagementService.</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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListGroups(Amazon.IdentityManagement.Model.ListGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListGroups operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListGroups operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroups operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListGroups operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListGroups.</param> <returns>Returns a ListGroupsResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListGroupsForUser(Amazon.IdentityManagement.Model.ListGroupsForUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListGroupsForUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListGroupsForUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroupsForUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListGroupsForUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListGroupsForUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListGroupsForUser.</param> <returns>Returns a ListGroupsForUserResult from IdentityManagementService.</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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListInstanceProfiles(Amazon.IdentityManagement.Model.ListInstanceProfilesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstanceProfiles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfiles operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstanceProfiles operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListInstanceProfiles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstanceProfiles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstanceProfiles.</param> <returns>Returns a ListInstanceProfilesResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListInstanceProfilesForRole(Amazon.IdentityManagement.Model.ListInstanceProfilesForRoleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInstanceProfilesForRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListInstanceProfilesForRole operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListInstanceProfilesForRole operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListInstanceProfilesForRole(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInstanceProfilesForRole operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListInstanceProfilesForRole.</param> <returns>Returns a ListInstanceProfilesForRoleResult from IdentityManagementService.</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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListMFADevices(Amazon.IdentityManagement.Model.ListMFADevicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListMFADevices operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMFADevices operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListMFADevices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMFADevices.</param> <returns>Returns a ListMFADevicesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListRolePolicies(Amazon.IdentityManagement.Model.ListRolePoliciesRequest)"> <summary> Lists the names of the policies associated with the specified role. 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListRolePolicies(Amazon.IdentityManagement.Model.ListRolePoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRolePolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListRolePolicies operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRolePolicies operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListRolePolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRolePolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRolePolicies.</param> <returns>Returns a ListRolePoliciesResult from IdentityManagementService.</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> <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </para> </summary> <returns>The response from the ListRoles service method, as returned by IdentityManagementService.</returns> </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> <para> The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to <a href="http://www.faqs.org/rfcs/rfc3986.html">http://www.faqs.org/rfcs/rfc3986.html</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListRoles(Amazon.IdentityManagement.Model.ListRolesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRoles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListRoles operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRoles operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListRoles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRoles operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRoles.</param> <returns>Returns a ListRolesResult from IdentityManagementService.</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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListSAMLProviders(Amazon.IdentityManagement.Model.ListSAMLProvidersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSAMLProviders operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListSAMLProviders operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSAMLProviders operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListSAMLProviders(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSAMLProviders operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSAMLProviders.</param> <returns>Returns a ListSAMLProvidersResult from IdentityManagementService.</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> </summary> <returns>The response from the ListServerCertificates service method, as returned by IdentityManagementService.</returns> </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> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListServerCertificates(Amazon.IdentityManagement.Model.ListServerCertificatesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListServerCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListServerCertificates operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListServerCertificates operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListServerCertificates(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListServerCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListServerCertificates.</param> <returns>Returns a ListServerCertificatesResult from IdentityManagementService.</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, this API can be used 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> </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, this API can be used 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListSigningCertificates(Amazon.IdentityManagement.Model.ListSigningCertificatesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSigningCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListSigningCertificates operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSigningCertificates operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListSigningCertificates(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSigningCertificates operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSigningCertificates.</param> <returns>Returns a ListSigningCertificatesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUserPolicies(Amazon.IdentityManagement.Model.ListUserPoliciesRequest)"> <summary> Lists the names of the policies associated with the specified user. 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListUserPolicies(Amazon.IdentityManagement.Model.ListUserPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUserPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListUserPolicies operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUserPolicies operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListUserPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUserPolicies operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUserPolicies.</param> <returns>Returns a ListUserPoliciesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUsers"> <summary> Lists the users that have the specified path prefix. 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ListUsers(Amazon.IdentityManagement.Model.ListUsersRequest)"> <summary> Lists the users that have the specified path prefix. 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginListUsers(Amazon.IdentityManagement.Model.ListUsersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUsers operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListUsers operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUsers operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListUsers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUsers operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUsers.</param> <returns>Returns a ListUsersResult from IdentityManagementService.</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.BeginListVirtualMFADevices(Amazon.IdentityManagement.Model.ListVirtualMFADevicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListVirtualMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ListVirtualMFADevices operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVirtualMFADevices operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndListVirtualMFADevices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListVirtualMFADevices operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListVirtualMFADevices.</param> <returns>Returns a ListVirtualMFADevicesResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutGroupPolicy(Amazon.IdentityManagement.Model.PutGroupPolicyRequest)"> <summary> Adds (or updates) a policy document associated with the specified group. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html" target="_blank">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>. <para> For information about limits on the number of policies you can associate with a group, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginPutGroupPolicy(Amazon.IdentityManagement.Model.PutGroupPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the PutGroupPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutGroupPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndPutGroupPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutGroupPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutGroupPolicy.</param> <returns>Returns a PutGroupPolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutRolePolicy(Amazon.IdentityManagement.Model.PutRolePolicyRequest)"> <summary> Adds (or updates) a policy document associated with the specified role. For information about policies, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html" target="_blank">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>. <para> For information about limits on the policies you can associate with a role, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginPutRolePolicy(Amazon.IdentityManagement.Model.PutRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the PutRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndPutRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutRolePolicy.</param> <returns>Returns a PutRolePolicyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.PutUserPolicy(Amazon.IdentityManagement.Model.PutUserPolicyRequest)"> <summary> Adds (or updates) a policy document associated with the specified user. For information about policies, refer to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html" target="_blank">Overview of Policies</a> in <i>Using AWS Identity and Access Management</i>. <para> For information about limits on the number of policies you can associate with a user, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginPutUserPolicy(Amazon.IdentityManagement.Model.PutUserPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the PutUserPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutUserPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndPutUserPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutUserPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutUserPolicy.</param> <returns>Returns a PutUserPolicyResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginRemoveRoleFromInstanceProfile(Amazon.IdentityManagement.Model.RemoveRoleFromInstanceProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveRoleFromInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the RemoveRoleFromInstanceProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveRoleFromInstanceProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndRemoveRoleFromInstanceProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveRoleFromInstanceProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveRoleFromInstanceProfile.</param> <returns>Returns a RemoveRoleFromInstanceProfileResult from IdentityManagementService.</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginRemoveUserFromGroup(Amazon.IdentityManagement.Model.RemoveUserFromGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveUserFromGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the RemoveUserFromGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveUserFromGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndRemoveUserFromGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveUserFromGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveUserFromGroup.</param> <returns>Returns a RemoveUserFromGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.ResyncMFADevice(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest)"> <summary> Synchronizes the specified MFA device with AWS servers. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginResyncMFADevice(Amazon.IdentityManagement.Model.ResyncMFADeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResyncMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the ResyncMFADevice operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResyncMFADevice operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndResyncMFADevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResyncMFADevice operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResyncMFADevice.</param> <returns>Returns a ResyncMFADeviceResult from IdentityManagementService.</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, this API can be used 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" target="_blank">Managing Keys and Certificates</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateAccessKey(Amazon.IdentityManagement.Model.UpdateAccessKeyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccessKey operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAccessKey operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateAccessKey(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAccessKey operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAccessKey.</param> <returns>Returns a UpdateAccessKeyResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAccountPasswordPolicy"> <summary> Updates the password policy settings for the 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateAccountPasswordPolicy(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest)"> <summary> Updates the password policy settings for the 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 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateAccountPasswordPolicy(Amazon.IdentityManagement.Model.UpdateAccountPasswordPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAccountPasswordPolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAccountPasswordPolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateAccountPasswordPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAccountPasswordPolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAccountPasswordPolicy.</param> <returns>Returns a UpdateAccountPasswordPolicyResult from IdentityManagementService.</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/WorkingWithRoles.html">Working with Roles</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateAssumeRolePolicy(Amazon.IdentityManagement.Model.UpdateAssumeRolePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAssumeRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAssumeRolePolicy operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateAssumeRolePolicy operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateAssumeRolePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAssumeRolePolicy operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAssumeRolePolicy.</param> <returns>Returns a UpdateAssumeRolePolicyResult from IdentityManagementService.</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" target="_blank">Renaming Users and Groups</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateGroup(Amazon.IdentityManagement.Model.UpdateGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateGroup operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateGroup operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateGroup operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateGroup.</param> <returns>Returns a UpdateGroupResult from IdentityManagementService.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.UpdateLoginProfile(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest)"> <summary> Changes the password for the specified user. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateLoginProfile(Amazon.IdentityManagement.Model.UpdateLoginProfileRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateLoginProfile operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateLoginProfile operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateLoginProfile(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateLoginProfile operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateLoginProfile.</param> <returns>Returns a UpdateLoginProfileResult from IdentityManagementService.</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"> </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateSAMLProvider(Amazon.IdentityManagement.Model.UpdateSAMLProviderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSAMLProvider operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSAMLProvider operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateSAMLProvider(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateSAMLProvider operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSAMLProvider.</param> <returns>Returns a UpdateSAMLProviderResult from IdentityManagementService.</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. <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/ManagingServerCerts.html" target="_blank">Managing Server Certificates</a> in <i>Using AWS Identity and Access Management</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/PermissionsAndPolicies.html" target="blank">Permissions and Policies</a>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateServerCertificate(Amazon.IdentityManagement.Model.UpdateServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServerCertificate.</param> <returns>Returns a UpdateServerCertificateResult from IdentityManagementService.</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, this API can be used to manage root credentials even if the AWS account has no associated users. </para> <para> For information about rotating certificates, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html" target="_blank">Managing Keys and Certificates</a> in <i>Using AWS Identity and Access Management</i>. </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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateSigningCertificate(Amazon.IdentityManagement.Model.UpdateSigningCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateSigningCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateSigningCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateSigningCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSigningCertificate.</param> <returns>Returns a UpdateSigningCertificateResult from IdentityManagementService.</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" target="_blank">Renaming Users and Groups</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUpdateUser(Amazon.IdentityManagement.Model.UpdateUserRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UpdateUser operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateUser operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUpdateUser(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateUser operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateUser.</param> <returns>Returns a UpdateUserResult from IdentityManagementService.</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 information about the number of server certificates you can upload, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUploadServerCertificate(Amazon.IdentityManagement.Model.UploadServerCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UploadServerCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadServerCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUploadServerCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadServerCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadServerCertificate.</param> <returns>Returns a UploadServerCertificateResult from IdentityManagementService.</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, this API can be used 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" target="_blank">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" target="_blank">Making Query Requests</a> in <i>Using IAM</i>.</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 to another user under 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> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.BeginUploadSigningCertificate(Amazon.IdentityManagement.Model.UploadSigningCertificateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="request">Container for the necessary parameters to execute the UploadSigningCertificate operation on AmazonIdentityManagementServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadSigningCertificate operation.</returns> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceClient.EndUploadSigningCertificate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadSigningCertificate operation. <seealso cref="T:Amazon.IdentityManagement.AmazonIdentityManagementService"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadSigningCertificate.</param> <returns>Returns a UploadSigningCertificateResult from IdentityManagementService.</returns> </member> <member name="T:Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig"> <summary> Configuration for accessing Amazon IdentityManagementService service </summary> </member> <member name="M:Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.IdentityManagement.AmazonIdentityManagementServiceConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.AccessKey"> <summary> The AccessKey data type contains information about an AWS access key. <para> This data type is used as a response element in the actions <a>CreateAccessKey</a> and <a>ListAccessKeys</a>. </para> </summary> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKey.WithAccessKeyId(System.String)"> <summary> Sets the AccessKeyId property </summary> <param name="accessKeyId">The value to set for the AccessKeyId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKey.WithCreateDate(System.DateTime)"> <summary> Sets the CreateDate property </summary> <param name="createDate">The value to set for the CreateDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKey.WithSecretAccessKey(System.String)"> <summary> Sets the SecretAccessKey property </summary> <param name="secretAccessKey">The value to set for the SecretAccessKey property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKey.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKey.WithUserName(System.String)"> <summary> Sets the UserName property </summary> <param name="userName">The value to set for the UserName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKey.AccessKeyId"> <summary> Gets and sets the property AccessKeyId. <para> The ID for this access key. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKey.CreateDate"> <summary> Gets and sets the property CreateDate. <para> The date when the access key was created. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKey.SecretAccessKey"> <summary> Gets and sets the property SecretAccessKey. <para> The secret key used to sign requests. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKey.Status"> <summary> Gets and sets the property Status. <para> The status of the access key. <code>Active</code> means the key is valid for API calls, while <code>Inactive</code> means it is not. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKey.UserName"> <summary> Gets and sets the property UserName. <para> Name of the user the key is associated with. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.AccessKeyMetadata"> <summary> The AccessKey data type contains information about an AWS access key, without its secret key. <para> This data type is used as a response element in the action <a>ListAccessKeys</a>. </para> </summary> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKeyMetadata.WithAccessKeyId(System.String)"> <summary> Sets the AccessKeyId property </summary> <param name="accessKeyId">The value to set for the AccessKeyId property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKeyMetadata.WithCreateDate(System.DateTime)"> <summary> Sets the CreateDate property </summary> <param name="createDate">The value to set for the CreateDate property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKeyMetadata.WithStatus(System.String)"> <summary> Sets the Status property </summary> <param name="status">The value to set for the Status property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AccessKeyMetadata.WithUserName(System.String)"> <summary> Sets the UserName property </summary> <param name="userName">The value to set for the UserName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKeyMetadata.AccessKeyId"> <summary> Gets and sets the property AccessKeyId. <para> The ID for this access key. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKeyMetadata.CreateDate"> <summary> Gets and sets the property CreateDate. <para> The date when the access key was created. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKeyMetadata.Status"> <summary> Gets and sets the property Status. <para> The status of the access key. <code>Active</code> means the key is valid for API calls, while <code>Inactive</code> means it is not. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AccessKeyMetadata.UserName"> <summary> Gets and sets the property UserName. <para> Name of the user the key is associated with. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest"> <summary> Container for the parameters to the AddRoleToInstanceProfile operation. 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> </member> <member name="M:Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest.WithInstanceProfileName(System.String)"> <summary> Sets the InstanceProfileName property </summary> <param name="instanceProfileName">The value to set for the InstanceProfileName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest.WithRoleName(System.String)"> <summary> Sets the RoleName property </summary> <param name="roleName">The value to set for the RoleName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest.InstanceProfileName"> <summary> Gets and sets the property InstanceProfileName. <para> Name of the instance profile to update. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AddRoleToInstanceProfileRequest.RoleName"> <summary> Gets and sets the property RoleName. <para> Name of the role to add. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.AddRoleToInstanceProfileResponse"> <summary> Returns information about the AddRoleToInstanceProfileResult response and response metadata. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.AddUserToGroupRequest"> <summary> Container for the parameters to the AddUserToGroup operation. Adds the specified user to the specified group. </summary> </member> <member name="M:Amazon.IdentityManagement.Model.AddUserToGroupRequest.WithGroupName(System.String)"> <summary> Sets the GroupName property </summary> <param name="groupName">The value to set for the GroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.AddUserToGroupRequest.WithUserName(System.String)"> <summary> Sets the UserName property </summary> <param name="userName">The value to set for the UserName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.AddUserToGroupRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> Name of the group to update. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.AddUserToGroupRequest.UserName"> <summary> Gets and sets the property UserName. <para> Name of the user to add. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.AddUserToGroupResponse"> <summary> Returns information about the AddUserToGroupResult response and response metadata. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.ChangePasswordRequest"> <summary> Container for the parameters to the ChangePassword operation. Changes the password of the IAM user calling <code>ChangePassword</code>. The root account password is not affected by this action. For information about modifying passwords, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html" target="_blank">Managing Passwords</a>. </summary> </member> <member name="M:Amazon.IdentityManagement.Model.ChangePasswordRequest.WithNewPassword(System.String)"> <summary> Sets the NewPassword property </summary> <param name="newPassword">The value to set for the NewPassword property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.ChangePasswordRequest.WithOldPassword(System.String)"> <summary> Sets the OldPassword property </summary> <param name="oldPassword">The value to set for the OldPassword property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.ChangePasswordRequest.NewPassword"> <summary> Gets and sets the property NewPassword. </summary> </member> <member name="P:Amazon.IdentityManagement.Model.ChangePasswordRequest.OldPassword"> <summary> Gets and sets the property OldPassword. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.ChangePasswordResponse"> <summary> Returns information about the ChangePasswordResult response and response metadata. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateAccessKeyRequest"> <summary> Container for the parameters to the CreateAccessKey operation. 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 API 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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</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> </member> <member name="M:Amazon.IdentityManagement.Model.CreateAccessKeyRequest.WithUserName(System.String)"> <summary> Sets the UserName property </summary> <param name="userName">The value to set for the UserName property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.CreateAccessKeyRequest.UserName"> <summary> Gets and sets the property UserName. <para> The user name that the new key will belong to. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateAccessKeyResponse"> <summary> Returns information about the CreateAccessKeyResult response and response metadata. </summary> </member> <member name="P:Amazon.IdentityManagement.Model.CreateAccessKeyResponse.CreateAccessKeyResult"> <summary> Gets and sets the CreateAccessKeyResult property. Represents the output of a CreateAccessKey operation. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateAccessKeyResult"> <summary> Contains the result of a successful invocation of the <a>CreateAccessKey</a> action. </summary> </member> <member name="M:Amazon.IdentityManagement.Model.CreateAccessKeyResult.WithAccessKey(Amazon.IdentityManagement.Model.AccessKey)"> <summary> Sets the AccessKey property </summary> <param name="accessKey">The value to set for the AccessKey property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.CreateAccessKeyResult.AccessKey"> <summary> Gets and sets the property AccessKey. <para> Information about the access key. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateAccountAliasRequest"> <summary> Container for the parameters to the CreateAccountAlias operation. This action 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" target="_blank">Using an Alias for Your AWS Account ID</a> in <i>Using AWS Identity and Access Management</i>. </summary> </member> <member name="M:Amazon.IdentityManagement.Model.CreateAccountAliasRequest.WithAccountAlias(System.String)"> <summary> Sets the AccountAlias property </summary> <param name="accountAlias">The value to set for the AccountAlias property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.CreateAccountAliasRequest.AccountAlias"> <summary> Gets and sets the property AccountAlias. <para> Name of the account alias to create. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateAccountAliasResponse"> <summary> Returns information about the CreateAccountAliasResult response and response metadata. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateGroupRequest"> <summary> Container for the parameters to the CreateGroup operation. 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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> </summary> </member> <member name="M:Amazon.IdentityManagement.Model.CreateGroupRequest.WithGroupName(System.String)"> <summary> Sets the GroupName property </summary> <param name="groupName">The value to set for the GroupName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.CreateGroupRequest.WithPath(System.String)"> <summary> Sets the Path property </summary> <param name="path">The value to set for the Path property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.CreateGroupRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> Name of the group to create. Do not include the path in this value. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.CreateGroupRequest.Path"> <summary> Gets and sets the property Path. <para> The path to the group. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> <para> This parameter is optional. If it is not included, it defaults to a slash (/). </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateGroupResponse"> <summary> Returns information about the CreateGroupResult response and response metadata. </summary> </member> <member name="P:Amazon.IdentityManagement.Model.CreateGroupResponse.CreateGroupResult"> <summary> Gets and sets the CreateGroupResult property. Represents the output of a CreateGroup operation. </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateGroupResult"> <summary> Contains the result of a successful invocation of the <a>CreateGroup</a> action. </summary> </member> <member name="M:Amazon.IdentityManagement.Model.CreateGroupResult.WithGroup(Amazon.IdentityManagement.Model.Group)"> <summary> Sets the Group property </summary> <param name="group">The value to set for the Group property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.CreateGroupResult.Group"> <summary> Gets and sets the property Group. <para> Information about the group. </para> </summary> </member> <member name="T:Amazon.IdentityManagement.Model.CreateInstanceProfileRequest"> <summary> Container for the parameters to the CreateInstanceProfile operation. 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" target="_blank">Limitations on IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para> </summary> </member> <member name="M:Amazon.IdentityManagement.Model.CreateInstanceProfileRequest.WithInstanceProfileName(System.String)"> <summary> Sets the InstanceProfileName property </summary> <param name="instanceProfileName">The value to set for the InstanceProfileName property </param> <returns>this instance</returns> </member> <member name="M:Amazon.IdentityManagement.Model.CreateInstanceProfileRequest.WithPath(System.String)"> <summary> Sets the Path property </summary> <param name="path">The value to set for the Path property </param> <returns>this instance</returns> </member> <member name="P:Amazon.IdentityManagement.Model.CreateInstanceProfileRequest.InstanceProfileName"> <summary> Gets and sets the property InstanceProfileName. <para> Name of the instance profile to create. </para> </summary> </member> <member name="P:Amazon.IdentityManagement.Model.CreateInstanceProfileRequest.Path"> <summary> Gets and sets the property Path. <para> The path to the instance profile. For more information about paths, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i>. </para>